375 Commits

Author SHA1 Message Date
Michael Bryan 4fb3bf7b4a Wrote a bit about docstrings 2016-06-12 19:51:46 +08:00
Zev Averbach 8b674a5b30 changed "tenants" to "tenets"
Tenants are people who pay rent; tenets are principles or beliefs.
2016-06-03 16:06:45 -07:00
dfowler 5888db734d Fix a few typos 2016-06-03 17:58:02 -04:00
Tom bdf3e1ea92 Fix incorrect dictConfig example
dictConfig expects a special `root` key outside of the `loggers` subdictionary in order to configure the root logger. I've tried the existing example code on python 2.7.5 and 3.5.1, and in neither case does the final log line produce any output (because the root logger remains set to `looging.WARN` by default). 

Changing the example to use the `root` key causes the log message to appear properly.

The `root` key is explained in PEP391: https://www.python.org/dev/peps/pep-0391/#dictionary-schema-detail
2016-05-10 17:05:23 -06:00
Grant Regimbal 44e72cd2e3 link to pep 257 2016-04-21 19:44:26 -05:00
gruzovator f7f4728833 more simple rm pyc files command 2016-04-19 11:55:48 +03:00
remcodraijer 02d68a86ed Changed summary line of docstring to follow PEP 0257 - update
Quoting https://www.python.org/dev/peps/pep-0257/#one-line-docstrings

"The docstring is a phrase ending in a period. It prescribes the function or method's effect as a command ("Do this", "Return that"), not as a description; e.g. don't write "Returns the pathname ...".
2016-03-24 12:33:39 +01:00
remcodraijer 6b4d013f52 Changed summary line of docstring to follow PEP 0257
Quoting https://www.python.org/dev/peps/pep-0257/#one-line-docstrings

The docstring is a phrase ending in a period. It prescribes the function or method's effect as a command ("Do this", "Return that"), not as a description; e.g. don't write "Returns the pathname ...".
2016-03-24 12:27:57 +01:00
Joachim Jablon a37543f242 Fixes #686 2016-03-17 00:25:34 +01:00
Marijn van der Zee 5e5d548a6c Include Youtube video using raw:: html directive 2016-03-12 14:19:09 +01:00
F. Gabriel Gosselin fada1cedd8 Fix pip requirements link
Missing < broke the link
2016-03-09 13:59:58 -08:00
Jacob Bryan 4e3b235a1c Update structure.rst
Updated a broken link to the pip website which explains a pip requirements file
2016-03-08 16:31:44 -06:00
kennethreitz fcbda9e147 ! 2016-02-21 21:52:29 -05:00
kennethreitz 5d32ad4e81 section on bytecode 2016-02-21 21:50:32 -05:00
kennethreitz ad28c338ee they see me stylin' 2016-02-21 19:10:42 -05:00
Ryan Malecky 7938a99f2e Updated documentation.rst - pycco homepage moved 2016-02-21 13:54:15 -05:00
kennethreitz 2c849a96ff Structure of the Repository 2016-02-13 09:48:54 -05:00
Kuldeep Singh 7aca6814e2 Added Note for xrange
Python 3 does not have xrange(). Uses range() instead.
2016-01-25 23:09:42 +05:30
Kuldeep Singh e6fb422d45 Changed xrange to range
Since xrange no longer works in python3
2016-01-25 22:28:46 +05:30
kennethreitz c843060d6d updates to context managers 2016-01-15 18:15:24 -05:00
kennethreitz 600615021e Merge pull request #627 from sirMackk/master
Adds context manager section to structure.rst
2016-01-15 18:13: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
sirMackk 77cf4f478d Adds context manager section to structure.rst 2015-10-24 07:30:38 +02:00
bhchance c3de9df0ff Update gotchas.rst
Previous test block did not show code blocks in markdown view.
2015-10-12 21:41:30 -05:00
poll0rz ecb5860d27 Add Diamond python project - Metrics collector 2015-10-12 01:37:15 +02:00
avi 00999cd2c9 Update gotchas.rst to make the sentence simpler 2015-10-05 20:12:05 +05:30
Ian Cordasco fecd5ec481 Merge pull request #576 from emilydolson/master
Resolved issue #174 by subdividing list idioms and replacing dict w/ set
2015-10-03 14:28:40 -05:00
emilydolson df255faa64 Fixed typo + formatting 2015-10-03 13:50:42 -04:00
Ian Cordasco ef32e9db1b Merge pull request #575 from dissolved/master
Typo and grammar fixes.
2015-10-03 11:08:05 -05:00
Ian Cordasco 0058198bb3 Merge pull request #578 from tkschmidt/typos
fixed a few typos
2015-10-03 11:00:14 -05:00
Tobias Schmidt 139a9671db fixed a few typos 2015-10-03 00:50:20 +02:00
Cadel Watson b0896e8468 Added usage instructions for autopep8 2015-10-03 08:27:13 +10:00
emilydolson 680f7d83d9 Resolved issue #174 by subdividing list idioms and replacing dict w/ set 2015-10-02 17:22:14 -04:00
Ryan Sandridge e79bbce255 Adding conjunction "and" after the serial comma. 2015-10-02 14:37:44 -04:00
Ryan Sandridge 45c01b0955 Fixing typo. Singular object, not plural. 2015-10-02 14:32:57 -04:00
Sriram Sundarraj ec78861eef Fixes #543. % is not depricated in PEP3101. 2015-07-17 16:12:58 +05:30
Kristi Nikolla f7ee56f50d Corrected line ending after removing broken link 2015-05-03 11:25:46 -04:00
Kristi Nikolla 28e365f1ea Removed broken link to Zen of Python in style.rst 2015-05-03 11:20:37 -04:00
taddeimania 060851270d Revise 'consenting adult' verbiage 2015-03-08 22:10:33 -05:00
Vincent Zee 7e385158c7 Corrected lines to be no longer than 78 characters 2015-03-01 16:27:06 +01: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
Michael Dunn 2b15ec8af2 Update logging.rst
Removed whitespace in violation of PEP 8 and aligned lines.
2015-02-10 21:06:36 -05:00
Michael Dunn 86d29a3c77 Update logging.rst
The name of a dictionary key `root` was not properly enclosed in quotes, which results in a syntax error when people copy this code.

Thanks!
2015-02-10 18:16:14 -05:00
Michael Dunn 4ffb7ff3d8 Update logging.rst
The PEP referenced for configuring logging via - '319' should be '391'.
Just a simple fix.
2015-02-10 17:15:18 -05:00
Ian Cordasco 0f797099e1 Change logging_config extension to ini 2015-01-18 09:59:38 -06:00
Tanya Schlusser df7a22568b Italic pro/con to bold, and '--' to colon after the pro/con 2015-01-17 21:43:22 -06:00
Tanya Schlusser 0c1551ae85 Added pro / con bullets to the list of ways to configure a logger 2015-01-17 21:09:52 -06:00
Tanya Schlusser 1cfb637cb1 Removed a stray capitalization and improved the grammar in the 'print' vs 'logging' section 2015-01-17 21:05:56 -06:00
Tanya Schlusser 7c37ec8396 Modified the new writing/logging.rst according to comments on the initial pull request 2015-01-17 20:59:53 -06:00