Edit docs for correctness and clarity #412
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
added 8 commits
January 13, 2015 17:53
Add the new resource param to the examples in the hook documentation.
Add a note to the middleware param documentation to ensure people don't mistakenly pass class types in lieu of instances of said classes.
Better express three of Falcon's most attractive features: performance, clean code, and no dependency on WebOb.
In order to reduce confusion, add a note about how to install the Falcon 0.2 beta and release candidates (as they become available). As part of this change, reconcile some of the differences between the installation instructions in the README and on Read the Docs.
… line Mitigate confusion around resp.status that may cause some developers to assign just a code to it, rather that the entire status line. See also issue falconry#266
Audit docstrings and touch up any that are unclear or out of date. Fix minor typos as they are discovered. Partially implements falconry#296
Update the README and quickstart example code to showcase the new middleware feature. Also tweak other parts of the example code, as needed, to be in sync with the latest updates to the framework. Partially implements falconry#296
…n pages Edit the prose in the existing documentation for clarity and correctness. Closes falconry#296
kgriffs
added a commit
that referenced
this pull request
Jan 23, 2015
Edit docs for correctness and clarity
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.
No description provided.