(docs) Add namespace to all public methods #552
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
keithamus
added a commit
that referenced
this pull request
Nov 15, 2015
(docs) Add namespace to all public methods
This was referenced Jan 31, 2016
This was referenced Feb 7, 2016
|
@keithamus, I am planning to add this as well in astorije/chai-immutable#39, at least for consistency with Chai, as I try to match the docstrings of my plugin as closely as possible to Chai's docstrings. |
|
It won't for plugins - this was just for core to generate docs. Feel free to add docstrings to help you maintain your own docs though. Also, you should take a look at #585, which will hopefully lead to having an easy way to generate docs, among other good things. |
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 will make generating the new sites' docs much easier.