Commit Graph

562 Commits

Author SHA1 Message Date
Miss Islington (bot) fdf48b6b88 bpo-35054: Add yet more index entries for symbols. (GH-10121) (GH-10171)
(cherry picked from commit 913876d824)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-28 18:43:32 +02:00
Miss Islington (bot) ec10b70ea6
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
(cherry picked from commit e483f02423)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-10-26 03:56:28 -07:00
Serhiy Storchaka 9a75b8470a
[3.7] bpo-35054: Add more index entries for symbols. (GH-10064). (GH-10120)
(cherry picked from commit ddb961d2ab)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-10-26 11:18:42 +03:00
Miss Islington (bot) 3e5bcd12f6
bpo-21196: Clarify name mangling rules in tutorial (GH-5667)
Initial patch by Chandan Kumar.
(cherry picked from commit 13ae4d4438)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2018-10-19 17:41:56 -07:00
Christophe Nanteuil 881ddffbff [3.7]Documentation minor update related to 3.6 - 3.7 migration (GH-9501)
Change version from 3.6 to 3.7 in the documentation when it addresses newcomers.

original request from python/python-docs-fr#273
2018-09-24 09:33:44 -07:00
Miss Islington (bot) d9c89111bd
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.htmlGH-format-string-syntax

https://bugs.python.org/issue34712
(cherry picked from commit 3705b98620)

Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
2018-09-19 13:30:40 -07:00
Miss Islington (bot) 037582eb7f
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.
(cherry picked from commit f019579828)

Co-authored-by: Lew Kurtz <37632626+lew18@users.noreply.github.com>
2018-09-10 18:49:39 -07:00
Miss Islington (bot) 854b740910 Doc: Missing 'f' in an f-string. (GH-9074) (GH-9095)
(cherry picked from commit 25fa141487)

Co-authored-by: Julien Palard <julien@palard.fr>
2018-09-07 11:59:00 +02:00
Miss Islington (bot) 66ff9d270c
Update list.remove(x) documentation (GH-8636)
Rephrase it to "It raises a `ValueError`"
(cherry picked from commit bcd1d971b6)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2018-08-02 20:03:19 -07:00
Miss Islington (bot) ec02c58f5a 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 20:52:18 +03:00
Miss Islington (bot) 49abd307d2 bpo-34161: Remove extra parentheses in output formatting tutorial (GH-8350)
The parentheses were incorrect.
(cherry picked from commit cb5f3fdb9d)

Co-authored-by: Aaqa Ishtyaq <aaqaishtyaq@gmail.com>
2018-07-20 13:38:06 -07:00
Miss Islington (bot) c87b1aabbd
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 17:51:03 -07:00
Miss Islington (bot) 80a5f04592
bpo-28626: rearrange discussion of output formatting to encourage f-strings (GH-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().
(cherry picked from commit ced350b195)

Co-authored-by: Andrew Kuchling <amk@amk.ca>
2018-07-09 06:52:48 -07:00
Miss Islington (bot) 79f70cee7b
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:17:14 -07:00
Miss Islington (bot) 5f165851b9
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:49:43 -07:00
Miss Islington (bot) 0f1a183269
bpo-33641: Convert RFC references into links. (GH-7103)
85% of them are already links.
(cherry picked from commit 0a36ac1a09)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-05-30 22:33:23 -07:00
Miss Islington (bot) 51b2f6d3a3 bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) (GH-6872)
(cherry picked from commit 19177fbd5d)

Co-authored-by: Stéphane Wirtel <stephane@wirtel.be>
2018-05-16 10:05:46 -04:00
Miss Islington (bot) 8ffff34ea1
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 01:54:38 -07:00
Miss Islington (bot) 1985849fe2
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:04:49 -07:00
Miss Islington (bot) f9005030fe
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:03:49 -07:00
Miss Islington (bot) b571958f54
Improve highlighting of some code blocks. (GH-6401)
(cherry picked from commit 46936d5a71)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2018-04-09 07:56:44 -07:00
Miss Islington (bot) 9216dffbc8
bpo-32337: Update documentats about dict order (GH-4973)
(cherry picked from commit dfbbbf16f9)

Co-authored-by: hui shang <shangdahao@gmail.com>
2018-04-03 22:01:46 -07:00
Miss Islington (bot) 3ca5efcef5
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-10 15:25:14 -08:00
Miss Islington (bot) e48e6499bb
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:35:52 -08:00
Miss Islington (bot) ddf2485103
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:13:33 -08:00
Emily Morehouse 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
Sanyam Khurana 1b4587a246 bpo-25910: Fixes redirection from http to https (#4674) 2017-12-06 17:39:33 +01:00
Will White 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
Raymond Hettinger 8c26a34f93 bpo-31757: Make Fibonacci examples consistent (#3991) 2017-10-14 07:36:08 -07:00
Trey Hunner 3fbd70018f bpo-30466: Add brief explanation of classes to tutorial (GH-1804) 2017-07-12 19:30:37 -07:00
regexaurus 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
Andrew Kuchling 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
suketa 1dbce04d0e bpo-30621: Update Input Output Tutorial Example(GH-2074)
import json before using json module
2017-06-11 18:42:59 -07:00
KatherineMichel ca81615344 bpo-30312: Small correction in datastructures set code sample (GH-2081) 2017-06-10 12:19:09 -07:00
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