decent developer api documentation

Idea

+tag

 

the documentation is useless when you are working with card sets (working in the sense of coding)

 

 

 

I needed the item count of a pointer and was wondering if there is method for that. 

To figure out that it doesn't exist I had to browse through related files like abstract/01_pointer.rb,  type/pointer.rb, all/collection.rb and to be absolutely sure that it's not hidden in some other all set I had to go to the console and call all reasonable name variations for a count method on a pointer card. In an ideal world this page should tell me http://www.rubydoc.info/gems/card/Card/Set/Type/Pointer but not even the #item_names method is there because it's defined in an all set.

 


Did getting that Yard adaptation to work help? I think we know that it is a manual process to run the documentation generation and though ti would be nice to automate, not a priority.

 

We will definitely have to keep an eye on the issue as we want to really have mods in libraries, whatever system holds and distributes them in the community.

Gerry Gleason.....2019-11-28 14:09:50 UTC

+relevant user stories