This repository was archived by the owner on Sep 6, 2023. It is now read-only.
API Docs
#633
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Any objection to taking individual method docs out of the current documentation system and relying on the yardocs instead (at first just linking to them appropriately, and possibly eventually moving the more narrative-based pages to Yardoc? - I'll have to learn how to do that.). It's just so tedious to be forced to document every method in the code, and then essentially duplicate that in the markdown. Of course we'd have to ensure the quality of the method tagging etc. is good on the Yardoc side for anything we remove from the markdown side (I.e. sometimes we document methods that came from Java that Yardoc doesn't -- yet -- know about).
Beta Was this translation helpful? Give feedback.
All reactions