Skip to content

Update learning.rst #340

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.

Sign up for GitHub

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
kennethreitz merged 3 commits into from Jan 8, 2014
Merged

Update learning.rst #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f7fb5e
Update learning.rst
Nov 18, 2013
203b92c
Update documentation.rst
Nov 25, 2013
bd71474
Update cli.rst
Nov 26, 2013
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
9 changes: 9 additions & 0 deletions docs/intro/learning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,12 @@ This is Python's reference manual, it covers the syntax and the core semantics o
language.

`The Python Language Reference <http://docs.python.org/reference/index.html>`_

Python Pocket Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Python Pocket Reference, written by Mark Lutz, is an easy to use reference to the
core language, with descriptions of commonly used modules and toolkits. It covers
Python 3 and 2.6 versions.

`Python Pocket Reference <http://shop.oreilly.com/product/9780596158095.do>`_
7 changes: 5 additions & 2 deletions docs/scenarios/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ Command Line Applications
Clint
-----

.. todo:: Write about Clint
`clint <https://pypi.python.org/pypi/clint/>`_ is a python module which is
filled with very useful tools for developing commandline applications.
It supports features such as; CLI Colors and Indents, Simple and Powerful
Column Printer, Iterator based progress bar and Implicit argument handling.

docopt
------

`docopt <http://docopt.org/>`_ is a lightweight, highly Pythonic package that
allows creating command line interfaces easily and intuitively, by parsing
POSIX-style usage instructions.
POSIX-style usage instructions.
4 changes: 3 additions & 1 deletion docs/writing/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ Reference`_ should help you familiarize yourself with its syntax.
Code Documentation Advice
-------------------------

Comments clarify code and begin with a hash (``#``).
Comments clarify the code and they are added with purpose of making the
code easier to understand. In Python, comments begin with a hash
(number sign) (``#``).

.. _docstring-ref:

Expand Down