Commit graph

535 commits

Author SHA1 Message Date
Miss Islington (bot)
cfadd1c242
bpo-28677: Improve phrasing of when instance attribute is referenced (GH-6208)
(cherry picked from commit c0f0a7669c)

Co-authored-by: Aaron Ang <aaronang@users.noreply.github.com>
2018-07-25 10:40:32 -07:00
Miss Islington (bot)
def4b063f3
Fix documentation for input and output tutorial (GH-8231)
The ValueError message ends with a period.
(cherry picked from commit 9cffdbffc3)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2018-07-10 18:08:43 -07:00
Miss Islington (bot)
c0327cefc7
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.
(cherry picked from commit df748c20da)

Co-authored-by: Behzad B. Mokhtari <35877268+perplexionist@users.noreply.github.com>
2018-06-26 21:20:10 -07:00
Miss Islington (bot)
f14e8eaaa5
bpo-33892: Doc: Use gender neutral words (GH-7770)
(cherry picked from commit 5092439c2c)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-06-17 21:54:51 -07:00
Serhiy Storchaka
55d9e865cb
[3.6] bpo-33641: Convert RFC references into links. (GH-7103) (GH-7276)
85% of them are already links.
(cherry picked from commit 0a36ac1a09)
2018-05-31 09:11:07 +03:00
Stéphane Wirtel
e4cd12d3d3 [3.6] bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) (GH-6885)
(cherry picked from commit 19177fbd5d)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-05-16 10:08:23 -04:00
Miss Islington (bot)
fa40fc0593
bpo-13525: Fix incorrect encoding name in the tutorial example. (GH-6738)
(cherry picked from commit ddb6215a55)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-05-09 02:00:13 -07:00
Miss Islington (bot)
0d19fa917c
Mention both relevant PEPs in function annotations tutorial (GH-6304)
Patch by Neeraj Badlani.
(cherry picked from commit 643ff711fa)

Co-authored-by: Neeraj Badlani <neerajbadlani@gmail.com>
2018-04-25 11:02:07 -07:00
Miss Islington (bot)
5c0a8bb1c2
bpo-33297: Mention Pillow to work with more image formats. (GH-6505)
Also update PIL doc references to Pillow.
(cherry picked from commit b81ca28b37)

Co-authored-by: Andrés Delfino <34587441+andresdelfino@users.noreply.github.com>
2018-04-21 06:04:08 -07:00
Serhiy Storchaka
1429ac9f2c
[3.6] Improve highlighting of some code blocks. (GH-6401). (GH-6424)
(cherry picked from commit 46936d5a71)
2018-04-09 17:57:07 +03:00
Miss Islington (bot)
3f7d0b69f2
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.
(cherry picked from commit 83d7062d2d)

Co-authored-by: Steven M. Vascellaro <S.Vascellaro@gmail.com>
2018-03-09 12:11:30 -08:00
Miss Islington (bot)
5a07608d08
bpo-31454: Include information about "import X as Y" in Modules tutorial (GH-4041)
(cherry picked from commit fbee88244e)

Co-authored-by: Mario Corchero <mariocj89@gmail.com>
2018-02-25 11:33:14 -08:00
Miss Islington (bot)
b9678d3aa1
bpo-25059: Clarify the print separator usage in tutorial (GH-5879)
By default `print` adds spaces between its arguments.
(cherry picked from commit 84c4b0cc67)

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
2018-02-25 11:21:15 -08:00
Miss Islington (bot)
f24c1857a8 bpo-32452: clarify term 'brackets' in generator tutorial (GH-5079) (#5081)
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. (GH-5079)
(cherry picked from commit f190eb59e6)
2018-01-02 08:36:06 -05:00
Miss Islington (bot)
7b909a93bf Improve the String tutorial docs (GH-4541) (GH-4545)
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.
(cherry picked from commit 78a5722ae9)
2017-11-24 09:35:08 -08:00
Trey Hunner
ef4231adb7 bpo-30466: Add brief explanation of classes to tutorial (GH-1804) (GH-2700) 2017-07-20 20:10:54 -07:00
regexaurus
c4cc5534fd Clarification to the break statement (GH-2453) (#GH-2457)
Clarify that the break statement breaks out of the innermost enclosing for or while loop.
(cherry picked from commit 36fc896740)
2017-06-27 19:38:22 -07:00
Mariatta
81c05ccc10 bpo-6519: Improve Python Input Output Tutorial (GH-2143) (GH-2145)
Move up the discussion about 'with' keyword, so it appears earlier in the document.
(cherry picked from commit bd4e9e0ca9)
2017-06-12 22:40:18 -07:00
Mariatta
47c9decb5f bpo-30621: Update Input Output Tutorial Example(GH-2074) (GH-2118)
import json before using json module
(cherry picked from commit 1dbce04d0e)
2017-06-11 18:59:05 -07:00
KatherineMichel
865ed9ea67 bpo-30312: Small correction in datastructures set code sample (GH-2081) (GH-2085)
(cherry picked from commit ca81615344)
2017-06-10 13:33:57 -07:00
Mariatta
d52f47a8f7 [3.6] bpo-30361: Use better example for mixed-type operands (GH-1701) (#1856)
(cherry picked from commit e405d4b8df)
2017-05-29 18:19:31 -04:00
Mariatta
af71364c3f [3.6] bpo-28315: Improve code examples in docs (GH-1372) (#1445)
Replace
   File "<stdin>", line 1, in ?
with
   File "<stdin>", line 1, in <module>
(cherry picked from commit 8856940cf2)
2017-05-03 18:41:20 -07:00
Mariatta
b00232842c Fix small typos in introduction and datastructures of tutorial (GH-272) (GH-297)
(cherry picked from commit 53c1892dc3)
2017-02-25 22:34:51 -08:00
Mariatta
9b49133082 bpo-29453: Remove reference to undefined dictionary ordering in Tutorial (GH-140) (#208)
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

(cherry picked from commit 32e8f9bdfd)
2017-02-21 10:30:07 -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
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
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
7bc01c32b1 Fixed mismatching title overline. 2016-12-04 15:42:13 +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
Serhiy Storchaka
223813111e Fixed mismatching title overline. 2016-12-04 15:43:37 +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
Raymond Hettinger
8c5e190d36 Issue #28587: Improve list examples in the tutorial 2016-11-21 16:29:50 -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
ecbca357c9 Closes #28713 uses OSError in the tutorial 2016-11-16 21:13:43 +05:30
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
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
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