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.

Task Manifest

#1

Tap needs a task manifest similar to that printed by rake -T

There are no naming conventions to glob for, but a manifest could be created by scanning files along load paths. Files that have a certain rdoc flag could be pulled into the manifest. The rdoc flag could be used to mark task documentation for the command line as well.

To keep everything up-to-date, you might check the manifest timestamp vs the timestamp for files along the load paths (although this might scale badly for MANY MANY files, that kind of prolific load path will likely be rare, and you could flag to prevent it).

Reported by bahuvrihi · April 15th, 2008 @ 08:26 AM

State: resolved
Milestone: Tap 0.10.0
Assigned to: bahuvrihi bahuvrihi

Activity

  1. bahuvrihi
    bahuvrihi
    • Milestone set to Tap 0.10.0

    April 17th, 2008 @ 04:20 PM

  2. bahuvrihi
    bahuvrihi

    Folder Implementation

    An obvious, but kind of heavy implementation is to gather all documentation into a manifest folder:

    • tap.manifest
    • .manifest
    • .tap

    Or something similar. It's a little hard to justify in that it's a total duplication of information already in the files, but it simplifies a variety of tasks such as:

    • only updating out-of-date information
    • pulling out just the info needed

    Harder to handle:

    • consistency with files that are changing
    • updates when the env configurations change

    File Implementation

    All the documentation could alternatively be collected into one .yml file using yaml documents. Loading would be a bit slower but management a little cleaner. Collecting the files in one place does not avoid the hard-to-handle issues of a directory.

    File as reference

    The file could be a reference for data that is slower to lookup... such as which files contain tasks, some reference time, and snippits current to the reference time.

    April 22nd, 2008 @ 08:13 AM

  3. bahuvrihi
    bahuvrihi
    • Tag set to feature, tap

    Some outlines of the documentation style for task manifests (and related documentation)

    June 27th, 2008 @ 09:57 AM

  4. bahuvrihi
    bahuvrihi
    • State changed from new to resolved
    • Assigned user set to bahuvrihi

    July 3rd, 2008 @ 08:38 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.