Adding some much needed seperate docs#56
Closed
seemethere wants to merge 1 commit intodbader:masterfrom
Closed
Conversation
Owner
|
Thanks for kicking things off here @seemethere! I think we need to set up a way for the API docs to be generated from docstrings in the source. I imagine the docs to be a combination of best practices / usage examples (currently in the FAQ) and the actual API docs. I really like the Flask docs to give an example: http://flask.pocoo.org/docs/0.10/ |
Owner
|
Linking this to #4 – we can possible reuse some of the copy there. Thank you – I'm closing this so we can keep the tracker clean of loose ends. Feel free to follow up (or make a separate issue) with more questions/discussion 😃 |
This file contains hidden or 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
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.
Responding to this:
#4
It's probably not fully what you want, but hey it's something.