kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix spelling in styleguide.rst

Browse Source
This commit is contained in:
Ryan Campbell
2012-07-03 21:43:08 -06:00
parent bd770496a2
commit d6f0ec1680
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/notes/styleguide.rst
+4 -4
View File
@@ -7,7 +7,7 @@ The Guide Style Guide
As with all documentation, having a consistent formating helps make the As with all documentation, having a consistent formating helps make the
document more understandable. In order to make The Guide easier to digest, document more understandable. In order to make The Guide easier to digest,
all contributions should fit within the rules of this style guide where all contributions should fit within the rules of this style guide where
approriate. appropriate.
The Guide is written as :ref:`restructuredtext-ref`. The Guide is written as :ref:`restructuredtext-ref`.
@@ -29,9 +29,9 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
Be sure to describe what and why you are linking. Be sure to describe what and why you are linking.
* `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_ * `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_
references where needed. references where needed.
* If a subject isn't directly relevant to Python, but useful in conjuction * If a subject isn't directly relevant to Python, but useful in conjunction
with Python (ex: Git, Github, Databases), reference by linking to useful with Python (ex: Git, Github, Databases), reference by linking to useful
resouces and describe why it's useful to Python. resources and describe why it's useful to Python.
* When in doubt, ask. * When in doubt, ask.
Headings Headings
@@ -115,7 +115,7 @@ Externally Linking
Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_ Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_
* Avoid using labels such as "click here", "this", etc. preferring * Avoid using labels such as "click here", "this", etc. preferring
decriptive labels (SEO worthy) instead. descriptive labels (SEO worthy) instead.
Linking to Sections in The Guide Linking to Sections in The Guide
-------------------------------- --------------------------------