Commit Graph

628 Commits

Author SHA1 Message Date
gfyoung e405d4b8df bpo-30361: Use better example for mixed-type operands (#1701) 2017-05-29 17:26:31 -04:00
UltimateCoder 8856940cf2 bpo-28315: Improve code examples in docs (GH-1372)
Replace
   File "<stdin>", line 1, in ? 
with 
   File "<stdin>", line 1, in <module>
2017-05-03 09:46:45 -07:00
Xiang Zhang b2d77175d1 bpo-29756: Improve documentation for list methods that compare items by equality (GH-572) 2017-03-13 10:09:16 +08:00
Jim Fasarakis-Hilliard 53c1892dc3 Fix small typos in introduction and datastructures of tutorial (GH-272)
* Fix small typos in introduction and datastructures
* Use iterable instead of L in the doc for list.extend
2017-02-25 13:13:33 -08:00
Jim Fasarakis-Hilliard 32e8f9bdfd bpo-29453: Remove reference to undefined dictionary ordering in Tutorial (GH-140)
As of Python 3.6 **kwargs are ordered, thus, remove the paragraph stating that
ordering is undefined and change snippet to remove the unecessary sorted call.

* Add sentence mentioning guaranteed output order of kwargs
2017-02-20 21:20:23 -09:00
Mariatta Wijaya bb19bf275b Issue #29381: merge with 3.6 2017-02-01 21:03:48 -08:00
Mariatta Wijaya 23dcccb75b Issue #29381: Clarify ordering of UNIX shebang line as source encoding line 2017-02-01 20:55:47 -08:00
Mariatta Wijaya 77bb0f4900 Backed out changeset 3d712292f2fa 2017-02-01 20:38:55 -08:00
Mariatta Wijaya e2d8bc52c4 Issue #29381: Clarify ordering of UNIX shebang line as source encoding line 2017-02-01 20:21:22 -08:00
R David Murray 39d60fa926 Merge: #29005: clarify terminology in tutorial 'method' discussion. 2016-12-18 15:01:38 -05:00
R David Murray cd259bfd5a Merge: #29005: clarify terminology in tutorial 'method' discussion. 2016-12-18 15:00:23 -05:00
R David Murray 4ec1590fbf #29005: clarify terminology in tutorial 'method' discussion.
Patch by Jim Fasarakis-Hilliard.
2016-12-18 14:59:58 -05:00
Martin Panter 9bcaa37e1c Issue #28820: Merge typo fixes from 3.6 2016-12-10 05:39:12 +00:00
Martin Panter b7880b067b Issue #28820: Merge spelling fixes from 3.5 2016-12-10 05:38:25 +00:00
Martin Panter 898573a734 Issue #28820: Fix spelling of “practice” as a noun 2016-12-10 05:12:56 +00:00
Serhiy Storchaka 8209cec0bd Fixed mismatching title overline. 2016-12-04 15:43:57 +02:00
Serhiy Storchaka 223813111e Fixed mismatching title overline. 2016-12-04 15:43:37 +02:00
Serhiy Storchaka 7bc01c32b1 Fixed mismatching title overline. 2016-12-04 15:42:13 +02:00
Serhiy Storchaka a8037db69d Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:22:36 +02:00
Serhiy Storchaka e418432dfb Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:22:09 +02:00
Serhiy Storchaka 29b0a26822 Fixed double hyphens that are rendered to literal en-dashes in the documenation. 2016-12-04 10:20:55 +02:00
Raymond Hettinger 1330eaa906 merge 2016-11-21 16:31:32 -08:00
Raymond Hettinger 8c5e190d36 Issue #28587: Improve list examples in the tutorial 2016-11-21 16:29:50 -08:00
Raymond Hettinger 1f56e25412 merge 2016-11-21 15:13:38 -08:00
Raymond Hettinger 5bd5b9d813 Issue 28587: list.index documentation missing start and stop arguments. (Contributed by Mariatta Wijaya.) 2016-11-21 15:12:54 -08:00
Kushal Das dfe2387e79 Closes #28713 uses OSError in the tutorial 2016-11-16 21:17:54 +05:30
Kushal Das ecbca357c9 Closes #28713 uses OSError in the tutorial 2016-11-16 21:13:43 +05:30
Berker Peksag e2d933b46e Issue #21864: Merge from 3.6 2016-11-06 21:16:29 +03:00
Berker Peksag 87170d672a Issue #21864: Merge from 3.5 2016-11-06 21:15:48 +03:00
Berker Peksag cea632ece5 Issue #21864: Remove outdated section about exceptions from the tutorial
Move the still relevant parts of it to the previous
chapter, "Errors and Exceptions".
2016-11-06 21:15:01 +03:00
Terry Jan Reedy 36925001e6 Merge with 3.6 2016-09-30 15:39:22 -04:00
Terry Jan Reedy b4b55eb582 Merge with 3.5 2016-09-30 15:39:05 -04:00
Terry Jan Reedy 30eee4deec Issue #28815: Change '?' to '<module>' in some doc examples.
Patch by Mariatta Wijaya.
2016-09-30 15:38:48 -04:00
Berker Peksag e5ccf3d699 Issue #28306: Merge from 3.5 2016-09-28 22:49:27 +03:00
Berker Peksag cf79cdb79d Issue #28306: Update exception message of ZeroDivisionError 2016-09-28 22:48:57 +03:00
Berker Peksag e0083e2b86 Issue #28306: Merge from 3.6 2016-09-28 22:49:46 +03:00
Ned Deily 4829bc6619 Bump to 3.7.0a0 2016-09-12 17:29:04 -04:00
Raymond Hettinger 87fe473edc merge 2016-08-12 09:44:18 -07:00
Raymond Hettinger 7f65af3d2d Issue 27719: Remove a doc example that is not applicable in Python 3 2016-08-12 09:43:59 -07:00
Zachary Ware c17dd50957 Closes #27206: Merge with 3.5 2016-08-09 17:45:15 -05:00
Zachary Ware c483a01a8f Issue #27206: Fix doctests in Doc/tutorial.
Patch by Jelle Zijlstra.
2016-08-09 17:44:52 -05:00
Martin Panter 6a09315ff0 Issue #26462: Merge code block fixes from 3.5 2016-07-29 01:49:37 +00:00
Martin Panter 1050d2d0c7 Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Brett Cannon 15552c39e0 Issue #27285: Document the deprecation of the pyvenv script.
As part of the update, the documentation was updated to normalize
around the term "virtual environment" instead of relying too heavily
on "venv" for the same meaning and leading to inconsistent usage of
either.

Thanks to Steve Piercy for the patch.
2016-07-08 10:46:21 -07:00
Martin Panter 2fec611a70 Issue #24314: Merge doc links from 3.5 2016-06-18 08:20:22 +00:00
Martin Panter bae5d81f5d Issue #24314: Fix doc links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Berker Peksag 0a5120e457 Issue #23116: Improve ask_ok() example in the Python tutorial 2016-06-02 11:31:19 -07:00
Berker Peksag 9c27c18c65 Issue #23116: Merge from 3.5 2016-06-02 11:31:51 -07:00
Berker Peksag c5f4036e6c Issue #27178: Fix markup in tutorial
Patch by Nathan Harold.
2016-06-01 14:38:18 -07:00
Berker Peksag ef1179e451 Issue #27174: Merge from 3.5 2016-06-01 09:53:05 -07:00
Berker Peksag 93818c752d Issue #27174: Update IPython URL in tutorial 2016-06-01 09:52:35 -07:00
Berker Peksag 12a8a8a0db Merge from 3.5 2016-06-01 09:36:40 -07:00
Berker Peksag 8e937f80c9 Fix typo in Python tutorial 2016-06-01 09:36:14 -07:00
Serhiy Storchaka c499f30286 Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Serhiy Storchaka 1acbf853c8 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:58 +03:00
Serhiy Storchaka 6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Serhiy Storchaka b6a9c9761c Issue #26778: Fixed "a/an/and" typos in code comment, documentation and error
messages.
2016-04-17 09:39:28 +03:00
Serhiy Storchaka 6a7b3a77b4 Issue #26778: Fixed "a/an/and" typos in code comment and documentation. 2016-04-17 08:32:47 +03:00
Georg Brandl 2d43bc2fc2 merge with 3.5 2016-02-22 14:53:03 +01:00
Georg Brandl f1d371bde9 Update example; str(float) changed so there is difference now. 2016-02-22 14:52:55 +01:00
Georg Brandl 40383c8f10 Minor clarification in tutorial. 2016-02-15 17:50:33 +01:00
Martin Panter bc1ee460dc Issue #25179: Documentation for formatted string literals aka f-strings
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
Martin Panter d5db14794b Issue #25179: Preparatory cleanup of existing docs on string formatting
* Various sections were pointing to the section on the string.Formatter
  class, when the section on the common format string syntax is probably more
  appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Martin Panter 46988d3659 Merge string formatting doc fixes from 3.5 2016-02-08 01:49:35 +00:00
Senthil Kumaran a8a3a1b7e8 merge from 3.5
Issue26135 - In the tutorial section on modules, reference importlib.reload instead of imp.reload.
2016-01-16 18:43:57 -08:00
Senthil Kumaran 80538e9dfe Issue26135 - In the tutorial section on modules, reference importlib.reload instead of imp.reload. 2016-01-16 18:43:24 -08:00
Ezio Melotti 2b06558769 #26001: merge with 3.5. 2016-01-12 11:27:58 +02:00
Ezio Melotti 397bb2486a #26001: mention in the tutorial that files in binary mode expect bytes, not str. 2016-01-12 11:27:30 +02:00
Martin Panter e56a919100 Issue #25523: Merge a-to-an corrections from 3.5 2015-11-02 04:27:17 +00:00
Martin Panter 2eb819f7a8 Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5 2015-11-02 04:04:57 +00:00
Martin Panter 7462b64911 Issue #25523: Correct "a" article to "an" article
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Serhiy Storchaka 233cdb3e9c Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:46:56 +03:00
Serhiy Storchaka 153627c111 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:46:20 +03:00
Serhiy Storchaka 0424eaf753 Marked keystrokes with the :kbd: role.
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
Raymond Hettinger 799b05b052 merge 2015-09-01 02:33:20 -07:00
Raymond Hettinger 502bf511b3 Improve tutorial suggestion for looping techniques 2015-09-01 02:33:02 -07:00
Jason R. Coombs ada5578f95 Merge with 3.5 for Issue #24729 2015-07-29 14:29:47 -04:00
Jason R. Coombs 0598da39ec Merge with 3.4 for Issue #24729 2015-07-29 14:29:26 -04:00
Jason R. Coombs 842c07414e Issue #24729: Correct reference to open function. 2015-07-29 14:04:36 -04:00
Alessandro Cucci d8de44b6b3 Issue #24729: Update tutorial to match implementation. 2015-07-28 21:00:10 +02:00
Tal Einat 8203ba99cc Merge from 3.5 2015-06-09 18:42:36 +03:00
Tal Einat 86a60bfb08 Merge from 3.4 2015-06-09 18:42:18 +03:00
Tal Einat f330d53691 #23891: correctly refer to PyPI as "Python Package Index" 2015-06-09 18:40:16 +03:00
Andrew Kuchling 81a612c859 Merge from 3.5 2015-06-08 18:24:46 -04:00
Andrew Kuchling 6b84335ada Merge from 3.4 2015-06-08 18:19:51 -04:00
Andrew Kuchling d00407115d #23891: remove extra words 2015-06-08 18:17:06 -04:00
Andrew Kuchling 3ae067d832 Merge from 3.5 2015-06-08 17:41:39 -04:00
Andrew Kuchling 21fd5a92de Merge from 3.4 2015-06-08 17:40:18 -04:00
Andrew Kuchling dd15b36c90 #23891: add a section to the Tutorial describing virtual environments and pip 2015-06-08 17:35:45 -04:00
Andrew Kuchling 1f49f8303a Merge from 3.5 2015-06-08 17:19:05 -04:00
Andrew Kuchling 20f628ee08 Merge from 3.4 2015-06-08 17:14:13 -04:00
Andrew Kuchling 4a75174fba Add link to pyvideoorg 2015-06-07 03:00:58 -04:00
Andrew Kuchling ecacfd80e3 #23891: rework discussion of python-list a bit 2015-06-06 20:25:21 -04:00
Yury Selivanov 7aa5341164 Reverting my previous commit.
Something went horribly wrong when I was doing `hg rebase`.
2015-05-30 10:57:56 -04:00
Ned Deily ffb40e5ec3 More version bumping to 3.6.
With the creation of the 3.5 branch earlier in the process,
it is necessary to do some of the version bumps now rather than at
final release time (for example, the equivalent of the 3.4->3.5 bumps
in f2bf12fa22c1).  (Some of those changes have already been made, for
example in 30f5e7ec6afe.)
2015-05-27 22:00:46 -07:00
Serhiy Storchaka e6efbdc947 Remove UTF-8 BOMs. 2015-05-25 12:29:53 +03:00
Serhiy Storchaka 410d77f230 Remove UTF-8 BOMs. 2015-05-25 12:27:39 +03:00
Brett Cannon f299abdafa Issue #23731: Implement PEP 488.
The concept of .pyo files no longer exists. Now .pyc files have an
optional `opt-` tag which specifies if any extra optimizations beyond
the peepholer were applied.
2015-04-13 14:21:02 -04:00
Zachary Ware 3f103462fb Closes #23932: Merge with 3.4 2015-04-13 11:32:01 -05:00
Zachary Ware f3b990e48c Issue #23932: Update the tutorial section on function annotations.
Patch by Juti Noppornpitak.
2015-04-13 11:30:47 -05:00
Berker Peksag 556e08e9b2 Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:53:33 +03:00
Berker Peksag 9575e1891f Issue #12955: Change the urlopen() examples to use context managers where appropriate.
Patch by Martin Panter.
2015-04-12 13:52:49 +03:00
Andrew Kuchling d71b170a4d #23891: describe a few more modules in the tutorial 2015-04-09 22:20:01 -04:00
Berker Peksag b820d0defc Issue #23286: Fix typo in the tutorial.
Patch by Mayank Tripathi.
2015-01-27 02:52:40 +02:00
Berker Peksag b68c420d8a Issue #23286: Fix typo in the tutorial.
Patch by Mayank Tripathi.
2015-01-27 02:52:14 +02:00
Serhiy Storchaka d3faf43f9b Issue #23181: More "codepoint" -> "code point". 2015-01-18 11:28:37 +02:00
Georg Brandl 3be472b5f7 Closes #23181: codepoint -> code point 2015-01-14 08:26:30 +01:00
Berker Peksag 64c8914048 Issue #23070: Fix a comment in the tutorial.
"Python" has 6 characters, not 7.

Reported by Ross Burnett.
2014-12-17 14:57:13 +02:00
Berker Peksag 2338156fa4 Issue #23070: Fix a comment in the tutorial.
"Python" has 6 characters, not 7.

Reported by Ross Burnett.
2014-12-17 14:56:47 +02:00
Berker Peksag 8b1cbd2b7c Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
Patch by Éric Araujo.
2014-12-10 01:47:02 +02:00
Berker Peksag 0ecd7ba968 Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
Patch by Éric Araujo.
2014-12-10 01:47:50 +02:00
Raymond Hettinger ffd842e1d6 Issue #22824: Updated reprlib output format for sets to use set literals. 2014-11-09 22:30:36 -08:00
Georg Brandl fe98180bce merge with 3.4 2014-10-31 09:29:48 +01:00
Georg Brandl f0d2ed73ac minor grammar fixes (from docs@python.org) 2014-10-31 09:29:38 +01:00
Georg Brandl 6b4c847c4f Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:26:26 +01:00
Georg Brandl 93a56cdc37 Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:25:41 +01:00
Georg Brandl 794e9bf1fe merge with 3.4 2014-10-29 10:27:06 +01:00
Georg Brandl 525d355984 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
R David Murray bbf4ae51e4 Merge #21739: mention subtle difference between loops and listcomps in tutorial. 2014-09-30 21:26:24 -04:00
R David Murray 6bd68608ff #21739: mention subtle difference between loops and listcomps in tutorial.
We don't want to go into a full explanation of scopes at this point in the
tutorial, so we just mention that the loop creates or overwrites a persistent
variable while the listcomp doesn't.  Not mentioning this would lead someone
to incorrectly assume loops and listcomps were *completely* equivalent, which
would confuse them later.

Original patch by Rose Ames, tweaked to remove the word 'scope'.
2014-09-30 21:25:38 -04:00
Senthil Kumaran 2f2920a17f merge from 3.4
Issue #16827: Make Interpreter introduction section of the tutorial more
focussed and move advanced section and customization information to a separate
file called appendix.

Patch credits: Jamayla Wiley, Ya-Ting Huang and James Brewer.
2014-09-18 21:37:26 +08:00
Senthil Kumaran 15e4833662 Issue #16827: Make Interpreter introduction section of the tutorial more
focussed and move advanced section and customization information to a separate
file called appendix.

Patch credits: Jamayla Wiley, Ya-Ting Huang and James Brewer.
2014-09-18 21:30:28 +08:00
Ezio Melotti 7d02a98f78 #22170: merge with 3.4. 2014-08-08 17:24:06 +03:00
Ezio Melotti 79a1ffde9b #22170: avoid printing newlines twice in tutorial example. 2014-08-08 17:23:32 +03:00
Raymond Hettinger c03dc0f164 merge 2014-06-24 13:03:54 -07:00
Raymond Hettinger 04ba0bb80c Issue #11974: Add tutorial section on class and instance variables
(Based on a patch from Renee Chu.)
2014-06-23 18:08:01 -07:00
Raymond Hettinger 07e048519b Issue 21575: Show list.sort() arguments in the tutorial. 2014-05-26 18:44:04 -07:00
Terry Jan Reedy a52ecc0a02 Merge with 3.4 2014-05-23 00:34:38 -04:00
Terry Jan Reedy e17de09101 Issue #21545: Add .pop example and tweak comment about pure mutation methods.
Patch prepared by David Harrigan.
2014-05-23 00:34:12 -04:00
Raymond Hettinger 53260eaa56 merge 2014-05-22 23:37:31 +01:00
Raymond Hettinger bd46e48381 Issue 21554: Repair an out-of-date tutorial example to reflect changes in shutil. 2014-05-22 23:37:09 +01:00
R David Murray fc1020d396 #20874: reflow paragraph. 2014-04-15 20:26:54 -04:00
R David Murray 0e0e391fa3 #20874: update tutorial wording: sophisticated line editing is now standard.
Patch by Rafael Mejia.
2014-04-15 20:25:18 -04:00
R David Murray 1b28088fd3 Merge #20874 fix. 2014-04-15 20:30:00 -04:00
Andrew Svetlov d6ee27895a Merge 3.4: Get rid of deprecated IOError in the doc 2014-04-01 01:14:27 +03:00
Andrew Svetlov 08af00047b Get rid of deprecated IOError in the doc 2014-04-01 01:13:30 +03:00
Raymond Hettinger 9c5e98ff29 merge 2014-03-28 16:39:45 -07:00
Raymond Hettinger 4ab532bbfe Issue 21014: Use booleans instead of 0 and 1 in examples. 2014-03-28 16:39:25 -07:00
Georg Brandl 60fa3533eb merge with 3.4 2014-03-23 23:04:45 +01:00
Georg Brandl 553e108fce tutorial: no "linux2" sys.platform on 3.x (thanks Arfrever) 2014-03-23 23:03:59 +01:00
Georg Brandl 3fa7ea1348 merge with 3.4 2014-03-22 20:39:08 +01:00
Georg Brandl 75c5ab49ed Closes #20975: make date in the interpreter banner a little more consistent 2014-03-22 20:38:11 +01:00
Larry Hastings f5002bd6ac Version bump to 3.5, step 2. 2014-03-16 23:05:59 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Nick Coghlan f7614d55a2 Close #19407: New installation & distribution guides
- based on pip and other PyPA tools
- includes references to the new Python Packaging User Guide
  where appropriate (and the relevant section is at least
  partially filled in)
- started new FAQ sections
- both guides aim to introduce users to basic open source
  concepts if they aren't aware of them
- existing guides have been relocated (now linked from the
  distutils docs) rather then removed, since there is
  some needed material that has yet to be relocated to the
  distutils docs as a reference for the legacy formats
2014-03-13 22:13:45 +10:00
Ezio Melotti c5f5e625aa #20740: merge with 3.3. 2014-02-24 20:59:48 +02:00
Ezio Melotti 6b532349d0 #20740: desquarify 2. 2014-02-24 20:58:31 +02:00