inline help could create generate help for the enums

Bug #711358 reported by Curtis Hovey
4
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Launchpad itself
Triaged
Low
Unassigned

Bug Description

Enums are intended to be self-documenting. The inline help system is plain HTML. Documenting an enum requires duplicating text and maintaining the duplication.

I may be possibly to extend HelpFolder to check the path in __call__ for enum documentation. Instead of streaming the file content, it could generate the html for the enum class and member descriptions as a definition list. I think the challenge is how is the enum located by the code. For example. I want to see the TeamSubscriptionPolicy values, so I set the link to /+help/+enum/TeamSubscriptionPolicy. How does the HelpFolder know that TeamSubscriptionPolicy is actually lp.registry.interfaces.person.TeamSubscriptionPolicy. Maybe it is okay to pass the class path and the logic will raise an error if the member is not a enum

Tags: docs help
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.