Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Styleguide: wrap at 78 chars #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 31, 2011
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 58 additions & 26 deletions 84 docs/notes/styleguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,34 @@
The Guide Style Guide
=====================

As with all documentation, having a consistent formating helps make the document more understandable. In order to make The Guide easier to digest, all contributions should fit within the rules of this style guide where approriate.
As with all documentation, having a consistent formating helps make the
document more understandable. In order to make The Guide easier to digest,
all contributions should fit within the rules of this style guide where
approriate.

The Guide is written as :ref:`restructuredtext-ref`.
The Guide is written as :ref:`restructuredtext-ref`.

.. note:: Parts of The Guide may not yet match this style guide. Feel free to update those parts to by in sync with The Guide Style Guide
.. note:: Parts of The Guide may not yet match this style guide. Feel free
to update those parts to by in sync with The Guide Style Guide

.. note:: On any page of the rendered HTML you can click "Show Source" to see how authors have styled the page.
.. note:: On any page of the rendered HTML you can click "Show Source" to
see how authors have styled the page.

Relevancy
---------

Stride to keep any contributions relevant to the :ref:`purpose of The Guide <about-ref>`.

* Avoid including too much information on subjects that don't directly relate to Python development.
* Prefer to link to other sources if the information is already out there. Be sure to describe what and why you are linking.
* `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_ references where needed.
* If a subject isn't directly relevant to Python, but useful in conjuction with Python (ex: Git, Github, Databases), reference by linking to useful resouces and describe why it's useful to Python.
Stride to keep any contributions relevant to the :ref:`purpose of The Guide
<about-ref>`.

* Avoid including too much information on subjects that don't directly
relate to Python development.
* Prefer to link to other sources if the information is already out there.
Be sure to describe what and why you are linking.
* `Cite <http://sphinx.pocoo.org/rest.html?highlight=citations#citations>`_
references where needed.
* If a subject isn't directly relevant to Python, but useful in conjuction
with Python (ex: Git, Github, Databases), reference by linking to useful
resouces and describe why it's useful to Python.
* When in doubt, ask.

Headings
Expand Down Expand Up @@ -49,11 +60,19 @@ Sub section headings::

Very Deep
~~~~~~~~~


Prose
-----

Wrap text lines at 78 characters. Where necessary, lines may exceed 78
characters, especially if wrapping would make the source text more difficult
to read.


Code Examples
-------------

Wrap all code examples within 70 characters to avoid horizontal scrollbars.
Wrap all code examples at 70 characters to avoid horizontal scrollbars.

Command line examples::

Expand All @@ -65,17 +84,21 @@ Command line examples::
Be sure to include the ``$`` prefix before each line.

Python interpreter examples::

Label the example::


.. code-block:: python

>>> import this

Python examples::

Descriptive title::

.. code-block:: python

def get_answer():
return 42
return 42

Externally Linking
------------------
Expand All @@ -86,16 +109,20 @@ Externally Linking

.. _Sphinx: http://sphinx.pocoo.org

* Prefer to use descriptive labels with inline links instead of leaving bare links::
* Prefer to use descriptive labels with inline links instead of leaving bare
links::

Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_

* Avoid using labels such as "click here", "this", etc. preferring decriptive labels (SEO worthy) instead.
* Avoid using labels such as "click here", "this", etc. preferring
decriptive labels (SEO worthy) instead.

Linking to Sections in The Guide
--------------------------------

To cross-reference other parts of this documentation, use the `:ref: <http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations>`_ keyword and labels.
To cross-reference other parts of this documentation, use the `:ref:
<http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations>`_
keyword and labels.

To make reference labels more clear and unique, always add a ``-ref`` suffix::

Expand All @@ -107,26 +134,31 @@ To make reference labels more clear and unique, always add a ``-ref`` suffix::
Notes and Warnings
------------------

Make use of the appropriate `admonitions directives <http://sphinx.pocoo.org/rest.html#directives>`_ when making notes.
Make use of the appropriate `admonitions directives
<http://sphinx.pocoo.org/rest.html#directives>`_ when making notes.

Notes::
.. note::

.. note::
The Hitchhiker’s Guide to the Galaxy has a few things to say
on the subject of towels. A towel, it says, is about the most
massively useful thing an interstellar hitch hiker can have.

Warnings::

.. warning:: DON'T PANIC

TODOs
-----

Please mark any incomplete areas of The Guide with a `todo directive <http://sphinx.pocoo.org/ext/todo.html?highlight=todo#directive-todo>`_. To avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub documents or large incomplete sections.
Please mark any incomplete areas of The Guide with a `todo directive
<http://sphinx.pocoo.org/ext/todo.html?highlight=todo#directive-todo>`_. To
avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub
documents or large incomplete sections.

::

.. todo::
Learn the Ultimate Answer to the Ultimate Question
of Life, The Universe, and Everything
.. todo::
Learn the Ultimate Answer to the Ultimate Question
of Life, The Universe, and Everything

Morty Proxy This is a proxified and sanitized view of the page, visit original site.