seequent / properties

An organizational aid and wrapper for validation and tab completion of class properties/traits.
http://propertiespy.rtfd.org
MIT License
18 stars 9 forks source link

linking to inherited class docs in the Properties docs #242

Open lheagy opened 6 years ago

lheagy commented 6 years ago

I really like how you have arranged headings and inheritance for the properties docs, @fwkoch, in particular providing a link for the parent class e.g. image

Do you think this could easily be added to the auto-doc heading for Required or Optional properties? e.g.

image

I could see this being quite handy. Might be out-of-scope, but just an idea I wanted to share!

fwkoch commented 6 years ago

Hi @lheagy - to make sure we are on the same page, is what you are suggestion basically to include the Bases: ... line you have in your example by default?

I like this idea. It's not quite as critical as having the link in Property classes - for those, inherited attributes (e.g. required, etc.) are not documented, so to see them all, you must follow the links (maybe this should be changed?). On the other hand, HasProperties classes have all the properties documented, including inherited properties, so you don't need to hunt in the parent classes (if all that makes sense?).

But still, documenting class inheritance adds valuable context and structure for the docs. I'll plan to include this as an option for the docs in a future release.

lheagy commented 6 years ago

Hi @fwkoch: yes, and thanks for clarifying about the HasProperties docs. I do agree that for getting the layout of the codebase as well as inherited methods, etc it would be helpful to have the Bases automatically included