Opened 3 months ago

Last modified 3 months ago

#1784 new defect

Modify chickadee to say what module an identifier is in

Reported by: johnwcowan Owned by:
Priority: major Milestone: someday
Component: documentation Version: 5.2.0
Keywords: chickadee Cc:
Estimated difficulty: easy

Description

Right now, if you want to call features, you have to know or guess which module to load. Changing chickadee to provide that information will help a great deal. (Looking through all the individual module pages works, but ugh.)

Change History (1)

comment:1 Changed 3 months ago by Mario Domenech Goulart

Not sure if I understand what you mean, but chickadee prints the "path" to the symbol you are looking the documentation for at the top of the page. For features, it shows chickadee » chicken » platform » feature.

chickadee is chickadee itself (not part of the module name, of course), chicken » platform is chicken.platform and features is the symbol you are seeing the documentation for. It's not very intuitive, admittedly.

That's more or less the same in chicken-doc:

$ chicken-doc features
path: (chicken platform features)

-- procedure: (features)

Returns a list of all registered features that will be accepted
as valid feature-identifiers by `cond-expand`.
Note: See TracTickets for help on using tickets.