Decorator based documentation #20
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows for reasonable top-level module help without any extra work.
help(lark)
help(path)
The section is renamed Functions because it no longer contains anything else. Module variables need to be documented another way. There may need to be a new doc.var() decorator to document variables similar to parameters.
Until auto generation of the docs is available this is the easiest way to be consistent.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This replaces the markdown reference docs with documentation served by the repl and the new "doc" module.
Eventually this will be used to generate markdown (or html) documentation to finally fix #4. But there is a little more work to do for that.