54 Commits

Author SHA1 Message Date
Lokesh Dhakal 558e60c33c Minor Changes 2020-11-22 15:54:31 +01:00
davidwales f93e747876 Fix broken Sphinx link 2019-12-12 14:20:13 +11:00
Marc Poulin 705e90ef43 Merge branch 'master' into standard-american-english 2018-12-20 15:03:09 -07:00
Andrew Janke a2555b9852 Standardize on American English for the Guide 2018-12-18 02:32:06 -05:00
Andrew Janke eb6ec70706 Typo, grammar, and style fixes 2018-12-17 17:23:26 -05:00
Marc Poulin 35c13bc9ea Fixed all H2 headings
Before, H2 fomratting was not consistent.
Now, all H2 headings use over/under asterisks.
2018-12-04 13:44:41 -07:00
Dan Bader 03ed5fbf0d Host photos locally 2018-07-16 17:51:29 -07:00
kennethreitz 088bbe9839 Update documentation.rst 2017-09-04 16:47:23 -04:00
Harry Moreno 6776b2ff22 Fix grammar 2017-07-31 17:01:06 -04:00
kennethreitz b81aa84d33 Merge pull request #712 from Michael-F-Bryan/docstrings
Wrote up a couple examples for docstrings
2016-10-31 11:14:32 -04:00
Sidney Pham 5ad43199de Fixed example docstring 2016-10-07 15:53:05 +11:00
Michael Bryan 10defd73a2 Added a bit so the transition from short to long docstrings flows better 2016-06-13 10:07:29 +08:00
Michael Bryan 3c0b0270ba Removed the rst/sphinx-style docstring example 2016-06-13 09:49:18 +08:00
Michael Bryan fb388b8f7b changed the pep 257 line from a see also to a normal line 2016-06-12 19:53:40 +08:00
Michael Bryan 4fb3bf7b4a Wrote a bit about docstrings 2016-06-12 19:51:46 +08:00
Grant Regimbal 44e72cd2e3 link to pep 257 2016-04-21 19:44:26 -05:00
Ryan Malecky 7938a99f2e Updated documentation.rst - pycco homepage moved 2016-02-21 13:54:15 -05:00
Udit Vasu dc7ee74d73 Changed to Unix 2015-10-30 08:55:59 -05:00
Udit Vasu 3a234de2a8 Capitalize few terms 2015-10-30 08:55:59 -05:00
Tobias Schmidt 139a9671db fixed a few typos 2015-10-03 00:50:20 +02:00
Vincent Zee 5aac29d245 Fixed the urls pointing to contribute and fixed some lines that were
longer than 78 characters.
2015-02-28 22:23:07 +01:00
george 1329ee2040 Removed spaces at the ends of lines. 2014-06-17 18:36:02 -06:00
george c3b3e766f9 Mostly line wraps, and a small grammar fix to writing/documentation. 2014-06-17 12:41:00 -06:00
Simeon Visser 71187f4274 Changed python into Python where needed 2014-05-25 20:58:19 +02:00
Zearin cc7b19356e Mark up files & directories 2014-04-11 11:26:37 -04:00
Zearin 1e4b4a5460 docs/**: Specify language for code-blocks (syntax highlighting! mmm…) 2014-03-28 13:26:24 -04:00
Ian Cordasco f52704926c Keep it neutral 2014-03-03 06:49:26 -06:00
Leonardo.Z 6edbe90266 Add a new documentation tool: MkDocs
MkDocs is a new and popular documentation tool written in Python. It's supported by ReadTheDoc.org.
2014-03-03 14:17:51 +08:00
ugurthemaster 203b92ce61 Update documentation.rst 2013-11-25 11:05:54 +02:00
kuyan b6f014342d Use the :pep: tag instead of directly linking PEPs 2013-07-30 13:05:56 -07:00
Kenneth Reitz b3146b58cc Merge pull request #244 from mkomitee/master
ctrl-v is not a comment toggle in vim
2013-03-06 09:47:56 -08:00
barisumog df402a1c8e minor typo in documentation.rst 2013-03-01 11:04:24 +02:00
Michael Komitee a6f9cc3508 Removing inaccurate statement
ctrl-v in vim activates visual block mode. visual block mode can be used to
insert a comment character, but is not itself a comment toggle.
2013-02-03 21:47:03 -05:00
Clint Howarth 29af1a2097 tighten, de-dup PEP8 content, improve formatting/organization 2012-09-22 08:19:00 -04:00
Ryan Campbell 7d66ac6d20 Fix spelling in documentation article 2012-07-03 21:32:00 -06:00
Ryan Campbell 63a2bfc514 Fix awkward wording in "Comments" section 2012-07-03 21:31:10 -06:00
Alex Vykalyuk 3874e1f1be Fixed a typo. 2012-05-15 20:09:48 +03:00
Alex Vykalyuk 44b8f5dbf2 Added a note about readthedocs.org at the documneting section 2012-05-15 00:56:49 +03:00
Niko Wenselowski 23370fa83a Make the inline link to docstrings work. 2012-05-12 22:05:31 +02:00
Niko Wenselowski 89f9147aec Added document ref to Sphinx. Inserted links at the Epydoc text. 2012-05-12 22:00:46 +02:00
Niko W a0b76ae6ff Added paragraph about Epydoc. 2012-05-12 20:54:40 +02:00
guibog 61e948e887 Clarifying a bit on commented code 2012-04-27 21:40:25 +08:00
guibog 68fc11453a Add on documentation and comments 2012-04-25 23:17:40 +08:00
Tomas Thor Jonsson 70ca1a8cef lines less than 80 chars in /writing/ 2012-04-23 20:24:39 +02:00
guibog 6ccfb2fff5 Adding a sample and explanation for doctests 2012-04-21 19:42:37 +08:00
Trey Hunner aeb8a0b51f pocco was renamed to pycco 2012-04-03 22:32:30 -07:00
Kevin Burke 67d6aa5dcd sharpen up vim section and spelling fixes 2012-03-13 00:31:05 -07:00
Kamil Kisiel 8a8a6c794f A variety of build error fixes 2012-01-02 06:26:12 -08:00
Mike Thornton 909bd39635 First pass at styleguide 2011-12-30 16:36:19 -06:00
Darius Bacon 1758ba7434 Fix indent in code examples. 2011-12-29 21:04:10 -08:00