Fix filestore docs #1376
Merged
Fix filestore docs #1376
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 6 commits
December 9, 2013 13:19
Correct storage_dir to storage_path. Correct case in titles (see doc guidelines). Fix Sphinx warnings - title underlines too long. When mentioning config settings, cross-reference them. When mentioning action functions, cross-reference them. api = API json = JSON python = Python Dedent parsed literals - the rst was formatted wrong so that it was outputting literals inside blockquotes.
If you're going to mention another section in the docs, cross-reference it properly. This way if that section gets moved or deleted, a Sphinx error will remind you to update the cross-reference (or Sphinx will do it automatically). Also users get a nice hyperlink.
Edit text for clarity, simplicity.
It'll be good if we can use this style (a Sphinx .. seealso::, near the top of the page) whenever we want to say "also see this page" in the docs. That'll make it a lot more predictable and easier for users to find, when one feature is connected to another.
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.
@nigelbabu @kindly See the commit messages for some docs tips