Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

config lazydoc enhancements

#64

Configuration documentation should be able to specify the short and arg_name values. A plausible format is:

  config :key, 'value' # (s) ARGNAME - description
  config :key, 'value' # (s) description
  config :key, 'value' # ARGNAME - description
  config :key, 'value' # description

To do this would require evaluation of the lazydoc BEFORE use in the command line (performance hit) since the short is required for optparse. The argname could be put off, in principle because it gets formatted during --help... the trick would be to put a placeholder like desc into the config argv.

Reported by bahuvrihi · July 22nd, 2008 @ 03:07 PM

State: invalid
Milestone: none
Assigned to: nobody

Activity

  1. bahuvrihi
    bahuvrihi
    • State changed from new to invalid

    I don't think this is that good of an idea, simply because of the performance hit. It's inconsistent with the ideas behind Configurable and Lazydoc... that you only load the documentation when you need to view it and all that you need to USE the config is already contained in the config.

    December 8th, 2008 @ 08:41 AM

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.