Commit Graph

303 Commits

Author SHA1 Message Date
monchitos 6e0c78df7b Adding a reminder for preventing a misuse of the example in "common gotchas/mutable default arguments" 2017-04-18 10:02:15 -05:00
kennethreitz db83c8f368 Merge pull request #798 from userlerueda/patch-1
Update logging.rst
2017-03-10 11:46:56 -05:00
kennethreitz 885185a5a0 Merge pull request #800 from thinkerbot/patch-1
Indentation typo
2017-03-10 11:45:39 -05:00
tv3141 f3bf91acec tests: use __file__ for package import 2017-02-28 11:33:48 +00:00
Simon Chiang d1f24121ef Indentation typo 2017-02-24 08:21:52 -07:00
Luis Rueda f20a2f63c4 Update logging.rst
Update to include changes proposed in issue #794
2017-02-23 13:48:52 -05:00
kennethreitz 2136f4b7cf Merge branch 'patch-1' of https://github.com/danshorstein/python-guide 2017-02-23 11:11:38 -05:00
Dan Shorstein 46b5e63b0a add example to mutable/immutable types
added the map example, with explanation
2017-02-18 11:03:26 -05:00
Gabbarnama 61ad4a642f Update structure.rst
Removed hyperlink from setup.py
2016-12-06 19:43:59 +05:30
caimaoy 1b2a943ad8 update tox docs url 2016-11-22 18:36:08 +08:00
kennethreitz 96fda54d28 Merge pull request #735 from robsonpeixoto/patch-1
Cleaning up *.py[co] and __pycache__ tip
2016-10-31 15:00:41 -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
kennethreitz bea106ace8 Merge pull request #743 from alphor/fix-alphor-typo
amending previous submission, fixing markdown
2016-10-31 11:13:34 -04:00
Sidney Pham 5ad43199de Fixed example docstring 2016-10-07 15:53:05 +11:00
Adam Chainz af7d603e97 Convert readthedocs links for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-09-21 08:31:09 +01:00
Ahmad Jarara 71257bed9e fixing markup on memoization link hint 2016-08-29 20:49:31 -04:00
Ahmad Jarara 7adc9c0d03 fix memoization typo, link to wikipedia's overview 2016-08-28 17:35:52 -04:00
Kevin Ndung'u 91df42f170 Fix .PHONY target rule
.PHONY should be followed by a colon
2016-08-10 16:58:21 +03:00
Robson Roberto Souza Peixoto 1bcc6d5cc8 Cleaning up *.py[co] and __pycache__ tip 2016-08-01 00:43:48 -03:00
kennethreitz 9f1ad9c862 Merge pull request #718 from kikisdeliveryservice/master
Clean up of tests.rst
2016-07-27 18:00:28 -04:00
Manas c31000c6b8 Update startproject in example
start-project should be startproject
https://docs.djangoproject.com/en/1.9/ref/django-admin/#django-admin-startproject
2016-07-27 12:28:41 +05:30
Thomas Gratier ecb39fcf6a Indent unindented content in numbered list 2016-07-16 21:48:36 +02:00
Aaron Peschel 82a89026b9 Don't treat targets as files
Currently, this sample Makefile has problems if there are any
files/directories named init or test in the same directory as the
makefile. This commit adds a phony to the sample Makefile so that these
targets are not treated as files.
2016-06-28 15:53:53 -07:00
kikisdeliveryservice 122f67bf05 Clean up of tests.rst 2016-06-21 13:06:58 -07:00
kikisdeliveryservice 2ed32ebe0d Clean up of intro paragraphs for clarity. 2016-06-20 13:38:23 -07: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
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