compas icon indicating copy to clipboard operation
compas copied to clipboard

Adding clickable link to base classes methods in online documentation

Open yck011522 opened this issue 5 years ago • 5 comments

Feature Request

  • Add docs for base classes methods such as those in BaseNetwork, Datastructure.
  • Allow their methods to be seen in the docs of their inherited class docs. Such as in Network.
  • In the docs, where there is the list of class methods / functions, label those that comes from base class. For example in some library documentation like this, there is a clickable label saying (Inherited from BaseClassName).

Details

Describe the solution you'd like

Today, I'm trying to inherit the newly reworked 0.15.x Network class. I read the docs/tutorial about the Network class implementation and I checked out all the class methods it has. There are access methods for edge_attribute and node_attributes but not network_attributes.

Took me a long time to dig out where and how I can use that. Of course, I remember I opened #482 a while ago. But this Feature Request is more about making the online doc more navigable.

yck011522 avatar Apr 20 '20 17:04 yck011522

you are right. the docs are a bit behind and do not reflect the latest changes. working on it now. will push updates regularly throughout the week...

tomvanmele avatar Apr 21 '20 06:04 tomvanmele

Cool. By the way, I also noticed that in the old days, we have a clickable [source] link from the docs. And that is very useful. Now those are gone.

Perhaps this is related to some restructuring of where the functions are located and they might be in different files. But if it is easy to bring the links back, please do. They are very convenient.

yck011522 avatar Apr 21 '20 11:04 yck011522

yes this broke during one of the intermediate updates but will come back indeed.

tomvanmele avatar Apr 21 '20 11:04 tomvanmele

Thanks

yck011522 avatar Apr 21 '20 11:04 yck011522

Is this done? Can it be closed?

gonzalocasas avatar Mar 28 '22 09:03 gonzalocasas

@gonzalocasas anytime you close two unicorns are united in an eternal bond

jf--- avatar Apr 08 '24 18:04 jf---

this is generally solved but there are a few instances where one of the classes in the chain is not part of the api docs. will be completely resolved very soon. considering the unicorns' eternal bliss, i think we can close it...

tomvanmele avatar Apr 08 '24 19:04 tomvanmele