3705b98620
bpo-34712: Fix style in examples in "Input and Output" (GH-9361)
...
A couple of fixes here to make this more PEP-8:
* Avoid multiple statements on one line with `;` statement separator -- this is very rare in Python and is "generally discouraged" in PEP 8 (and if used, per PEP 8 there shouldn't be a space before the `;`)
* Add output for the first "Formatted String Literals" example. (Side note: are the doctests for this being run? If so, why didn't it fail?)
* Avoid space before `!r`. I have generally not seen spaces before the `!`, and this also matches the style used in the docs here: https://docs.python.org/3/library/string.html#format-string-syntax
https://bugs.python.org/issue34712
2018-09-19 03:28:28 -07:00
f019579828
bpo-33460: remove ellipsis that look like continuation prompts (GH-7851)
...
Remove ellipsis that look like continuation prompts,
has a side benefit of putting rest of error message in proper text color.
2018-09-10 18:13:08 -07:00
25fa141487
Doc: Missing 'f' in an f-string. (GH-9074)
2018-09-07 11:31:47 +02:00
bcd1d971b6
Update list.remove(x) documentation (GH-8636)
...
Rephrase it to "It raises a `ValueError`"
2018-08-02 19:45:48 -07:00
c0f0a7669c
bpo-28677: Improve phrasing of when instance attribute is referenced (GH-6208)
2018-07-25 17:21:32 +03:00
cb5f3fdb9d
Remove extra parentheses in output formatting tutorial (GH-8350)
...
The parentheses were incorrect.
2018-07-20 09:06:44 -07:00
9cffdbffc3
Fix documentation for input and output tutorial (GH-8231)
...
The ValueError message ends with a period.
2018-07-10 17:11:34 -07:00
ced350b195
bpo-28626: rearrange discussion of output formatting to encourage f-strings ( #6036 )
...
The 'output formatting' section of the tutorial talks a lot about manual formatting with things like .rjust() and .zfill(), with only a passing reference to 3.6's new f-strings.
This doesn't drop all of the old material, but it does rearrange the topics into a more modern order: f-strings first, discussing formatting specifiers a bit; then calling .format(); finally manual formatting with .ljust().
2018-07-07 17:36:23 -04:00
df748c20da
use rich markup for PEP reference (GH-7939)
...
it's better to refer to PEP with `pep` role in reStructuredText. It also links to the PEP page.
2018-06-26 20:57:39 -07:00
5092439c2c
bpo-33892: Doc: Use gender neutral words (GH-7770)
2018-06-18 13:34:30 +09:00
0a36ac1a09
bpo-33641: Convert RFC references into links. (GH-7103)
...
85% of them are already links.
2018-05-31 07:39:00 +03:00
19177fbd5d
bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814)
2018-05-15 14:58:35 -04:00
ddb6215a55
bpo-13525: Fix incorrect encoding name in the tutorial example. (GH-6738)
2018-05-09 11:10:55 +03:00
643ff711fa
Mention both relevant PEPs in function annotations tutorial (GH-6304)
...
Patch by Neeraj Badlani.
2018-04-25 12:52:13 -05:00
b81ca28b37
bpo-33297: Mention Pillow to work with more image formats. ( #6505 )
...
Also update PIL doc references to Pillow.
2018-04-21 15:17:26 +03:00
46936d5a71
Improve highlighting of some code blocks. (GH-6401)
2018-04-08 19:18:04 +03:00
dfbbbf16f9
bpo-32337: Update documentats about dict order (GH-4973)
2018-04-04 13:55:05 +09:00
83d7062d2d
controlflow: Use full example for "5 through 9" (GH-5907)
...
Replace example result of "5 through 9" with complete list: "5, 6, 7, 8, 9".
This format is more consistent with the surrounding examples.
2018-03-09 11:57:21 -08:00
fbee88244e
bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041)
2018-02-25 11:11:12 -08:00
84c4b0cc67
bpo-25059: Clarify the print separator usage in tutorial (GH-5879)
...
By default `print` adds spaces between its arguments.
2018-02-25 11:06:01 -08:00
ab328756d7
bpo-32722: Remove useless example in the Classes tutorial ( #5446 )
...
In the tutorial about the Generator expression, there is an example with
a dict comprehension and not with a generator expression, just removed
the code.
2018-02-01 15:31:07 +08:00
5489bdad51
Start of 3.8.0a0
2018-01-31 17:44:09 -05:00
f190eb59e6
bpo-32452: clarify term 'brackets' in generator tutorial ( #5079 )
...
Updates documentation for generator expressions in classes tutorial: Clarify usage of ambiguous term "brackets" by replacing with "square brackets". Updated subsequent lines to respect line breaks. (#5079 )
2018-01-01 20:34:53 -05:00
1b4587a246
bpo-25910: Fixes redirection from http to https ( #4674 )
2017-12-06 17:39:33 +01:00
78a5722ae9
Improve the String tutorial docs (GH-4541)
...
The paragraph that contains example of string literal concatenation was placed
after the section about concatenation using the '+' sign.
Moved the paragraph to the appropriate section.
2017-11-24 09:28:12 -08:00
8c26a34f93
bpo-31757: Make Fibonacci examples consistent ( #3991 )
2017-10-14 07:36:08 -07:00
3fbd70018f
bpo-30466: Add brief explanation of classes to tutorial (GH-1804)
2017-07-12 19:30:37 -07:00
36fc896740
Clarification to the `break` statement (GH-2453)
...
Clarify that the break statement breaks out of the innermost enclosing for or while loop.
2017-06-27 15:40:41 -07:00
bd4e9e0ca9
bpo-6519: Improve Python Input Output Tutorial (GH-2143)
...
Move up the discussion about 'with' keyword, so it appears earlier in the document.
2017-06-12 22:31:01 -07:00
1dbce04d0e
bpo-30621: Update Input Output Tutorial Example(GH-2074)
...
import json before using json module
2017-06-11 18:42:59 -07:00
ca81615344
bpo-30312: Small correction in datastructures set code sample (GH-2081)
2017-06-10 12:19:09 -07:00
e405d4b8df
bpo-30361: Use better example for mixed-type operands ( #1701 )
2017-05-29 17:26:31 -04:00
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
b2d77175d1
bpo-29756: Improve documentation for list methods that compare items by equality (GH-572)
2017-03-13 10:09:16 +08:00
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
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
bb19bf275b
Issue #29381 : merge with 3.6
2017-02-01 21:03:48 -08:00
23dcccb75b
Issue #29381 : Clarify ordering of UNIX shebang line as source encoding line
2017-02-01 20:55:47 -08:00
77bb0f4900
Backed out changeset 3d712292f2fa
2017-02-01 20:38:55 -08:00
e2d8bc52c4
Issue #29381 : Clarify ordering of UNIX shebang line as source encoding line
2017-02-01 20:21:22 -08:00
39d60fa926
Merge: #29005 : clarify terminology in tutorial 'method' discussion.
2016-12-18 15:01:38 -05:00
cd259bfd5a
Merge: #29005 : clarify terminology in tutorial 'method' discussion.
2016-12-18 15:00:23 -05:00
4ec1590fbf
#29005 : clarify terminology in tutorial 'method' discussion.
...
Patch by Jim Fasarakis-Hilliard.
2016-12-18 14:59:58 -05:00
9bcaa37e1c
Issue #28820 : Merge typo fixes from 3.6
2016-12-10 05:39:12 +00:00
b7880b067b
Issue #28820 : Merge spelling fixes from 3.5
2016-12-10 05:38:25 +00:00
898573a734
Issue #28820 : Fix spelling of “practice” as a noun
2016-12-10 05:12:56 +00:00
8209cec0bd
Fixed mismatching title overline.
2016-12-04 15:43:57 +02:00
223813111e
Fixed mismatching title overline.
2016-12-04 15:43:37 +02:00
7bc01c32b1
Fixed mismatching title overline.
2016-12-04 15:42:13 +02:00
a8037db69d
Fixed double hyphens that are rendered to literal en-dashes in the documenation.
2016-12-04 10:22:36 +02:00
e418432dfb
Fixed double hyphens that are rendered to literal en-dashes in the documenation.
2016-12-04 10:22:09 +02:00
29b0a26822
Fixed double hyphens that are rendered to literal en-dashes in the documenation.
2016-12-04 10:20:55 +02:00
1330eaa906
merge
2016-11-21 16:31:32 -08:00
8c5e190d36
Issue #28587 : Improve list examples in the tutorial
2016-11-21 16:29:50 -08:00
1f56e25412
merge
2016-11-21 15:13:38 -08:00
5bd5b9d813
Issue 28587: list.index documentation missing start and stop arguments. (Contributed by Mariatta Wijaya.)
2016-11-21 15:12:54 -08:00
dfe2387e79
Closes #28713 uses OSError in the tutorial
2016-11-16 21:17:54 +05:30
ecbca357c9
Closes #28713 uses OSError in the tutorial
2016-11-16 21:13:43 +05:30
e2d933b46e
Issue #21864 : Merge from 3.6
2016-11-06 21:16:29 +03:00
87170d672a
Issue #21864 : Merge from 3.5
2016-11-06 21:15:48 +03:00
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
36925001e6
Merge with 3.6
2016-09-30 15:39:22 -04:00
b4b55eb582
Merge with 3.5
2016-09-30 15:39:05 -04:00
30eee4deec
Issue #28815 : Change '?' to '<module>' in some doc examples.
...
Patch by Mariatta Wijaya.
2016-09-30 15:38:48 -04:00
e5ccf3d699
Issue #28306 : Merge from 3.5
2016-09-28 22:49:27 +03:00
cf79cdb79d
Issue #28306 : Update exception message of ZeroDivisionError
2016-09-28 22:48:57 +03:00
e0083e2b86
Issue #28306 : Merge from 3.6
2016-09-28 22:49:46 +03:00
4829bc6619
Bump to 3.7.0a0
2016-09-12 17:29:04 -04:00
87fe473edc
merge
2016-08-12 09:44:18 -07:00
7f65af3d2d
Issue 27719: Remove a doc example that is not applicable in Python 3
2016-08-12 09:43:59 -07:00
c17dd50957
Closes #27206 : Merge with 3.5
2016-08-09 17:45:15 -05:00
c483a01a8f
Issue #27206 : Fix doctests in Doc/tutorial.
...
Patch by Jelle Zijlstra.
2016-08-09 17:44:52 -05:00
6a09315ff0
Issue #26462 : Merge code block fixes from 3.5
2016-07-29 01:49:37 +00:00
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
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
2fec611a70
Issue #24314 : Merge doc links from 3.5
2016-06-18 08:20:22 +00:00
bae5d81f5d
Issue #24314 : Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
0a5120e457
Issue #23116 : Improve ask_ok() example in the Python tutorial
2016-06-02 11:31:19 -07:00
9c27c18c65
Issue #23116 : Merge from 3.5
2016-06-02 11:31:51 -07:00
c5f4036e6c
Issue #27178 : Fix markup in tutorial
...
Patch by Nathan Harold.
2016-06-01 14:38:18 -07:00
ef1179e451
Issue #27174 : Merge from 3.5
2016-06-01 09:53:05 -07:00
93818c752d
Issue #27174 : Update IPython URL in tutorial
2016-06-01 09:52:35 -07:00
12a8a8a0db
Merge from 3.5
2016-06-01 09:36:40 -07:00
8e937f80c9
Fix typo in Python tutorial
2016-06-01 09:36:14 -07:00
c499f30286
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
1acbf853c8
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:58 +03:00
6dff0205b7
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:07 +03:00
b6a9c9761c
Issue #26778 : Fixed "a/an/and" typos in code comment, documentation and error
...
messages.
2016-04-17 09:39:28 +03:00
6a7b3a77b4
Issue #26778 : Fixed "a/an/and" typos in code comment and documentation.
2016-04-17 08:32:47 +03:00
2d43bc2fc2
merge with 3.5
2016-02-22 14:53:03 +01:00
f1d371bde9
Update example; str(float) changed so there is difference now.
2016-02-22 14:52:55 +01:00
40383c8f10
Minor clarification in tutorial.
2016-02-15 17:50:33 +01:00
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
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
46988d3659
Merge string formatting doc fixes from 3.5
2016-02-08 01:49:35 +00:00
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
80538e9dfe
Issue26135 - In the tutorial section on modules, reference importlib.reload instead of imp.reload.
2016-01-16 18:43:24 -08:00
2b06558769
#26001 : merge with 3.5.
2016-01-12 11:27:58 +02:00
397bb2486a
#26001 : mention in the tutorial that files in binary mode expect bytes, not str.
2016-01-12 11:27:30 +02:00
Ben Hoyt
Lew Kurtz
Julien Palard
Lysandros Nikolaou
Aaron Ang
Aaqa Ishtyaq
Andrew Kuchling
Behzad B. Mokhtari
Andrés Delfino
Serhiy Storchaka
Stéphane Wirtel
Neeraj Badlani
Andrés Delfino
hui shang
Steven M. Vascellaro
Mario Corchero
Cheryl Sabella
Ned Deily
Emily Morehouse
Sanyam Khurana
Will White
Raymond Hettinger
Trey Hunner
regexaurus
suketa
KatherineMichel
gfyoung
UltimateCoder
Xiang Zhang
Jim Fasarakis-Hilliard
Mariatta Wijaya
R David Murray
Martin Panter
Raymond Hettinger
Kushal Das
Berker Peksag
Terry Jan Reedy
Zachary Ware
Brett Cannon
Georg Brandl
Senthil Kumaran
Ezio Melotti