Commit Graph

587 Commits

Author SHA1 Message Date
Miss Islington (bot) d2faac63af bpo-38678: Improve argparse example in tutorial (GH-17207) (GH-17213)
(cherry picked from commit 04c79d6088)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2019-11-17 22:17:28 -08:00
Jules Lasne (jlasne) 1bfc56759f [3.7] [3.8] Update interpreter.rst (GH-17059) (GH-17060) (GH-17061)
Fixed what seemed to be a weird phrasing.

(cherry picked from commit 5e01a6542a)

Co-authored-by: Jules Lasne (jlasne) <jules.lasne@gmail.com>.
(cherry picked from commit 1eac437e8d)

Co-authored-by: Jules Lasne (jlasne) <jules.lasne@gmail.com>
2019-11-05 15:02:09 +01:00
Miss Islington (bot) 5017a645b0 bpo-38130: Fix error in explaining when an exception is re-raised (GH-16016) (GH-16416)
Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>
(cherry picked from commit 1ad7be2f16)

Co-authored-by: Mohammad Dehghan <md.unicorn@gmail.com>
2019-09-26 11:15:21 +02:00
Miss Islington (bot) 20d3bce3ef [3.7] bpo-38218: Doc: Corrected syntax for return annotation (GH-16265) (GH-16275)
Signed-off-by: Jason Plurad <pluradj@us.ibm.com>
(cherry picked from commit 9ab6038fe8)

Co-authored-by: Jason Plurad <pluradj@us.ibm.com>
2019-09-19 07:37:38 +02:00
Miss Islington (bot) 8b907a8875 bpo-37904: Edition on python tutorial - section 4 (GH-16169) (GH-16235)
A little change on first paragraph of python tutorial to be more clearly

https://bugs.python.org/issue37904

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit b57481318e)

Co-authored-by: Diego Alberto Barriga Martínez <diegobarriga@protonmail.com>
2019-09-18 06:36:35 -04:00
Miss Islington (bot) ad4ce9edf3 Doc: Add link of GNU Readline library to interpreter tutorial (GH-16152) (GH-16188)
(cherry picked from commit f18242be16)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-09-16 18:29:50 +02:00
Miss Islington (bot) b9f932f9e2
bpo-37635: Update arg name for seek() in IO tutorial (GH-16147)
Typically, the second positional argument for ``seek()`` is *whence*. That is the POSIX standard name (http://man7.org/linux/man-pages/man3/lseek.3p.html) and the name listed in the documentation for ``io`` module (https://docs.python.org/3/library/io.htmlGH-io.IOBase.seek).

The tutorial for IO is the only location where the second positional argument for ``seek()`` is referred to as *from_what*. I suspect this was created at an early point in Python's history, and was never updated (as this section predates the GitHub repository):

```
$ git grep "from_what"
Doc/tutorial/inputoutput.rst:To change the file object's position, use ``f.seek(offset, from_what)``.  The position is computed
Doc/tutorial/inputoutput.rst:the *from_what* argument.  A *from_what* value of 0 measures from the beginning
Doc/tutorial/inputoutput.rst:the reference point.  *from_what* can be omitted and defaults to 0, using the
```

For consistency, I am suggesting that the tutorial be updated to use the same argument name as the IO documentation and POSIX standard for ``seek()``, particularly since this is the only location where *from_what* is being used.

Note: In the POSIX standard, *whence* is technically the third positional argument, but the first argument *fildes* (file descriptor) is implicit in Python.

https://bugs.python.org/issue37635
(cherry picked from commit ff603f6c3d)

Co-authored-by: Kyle Stanley <aeros167@gmail.com>
2019-09-14 13:47:39 -07:00
Miss Islington (bot) e4be7c8ba1 Improve clarity of try-return-finally-return (GH-15677) (GH-15982)
Clarify execution in try-return-finally-return case.
(cherry picked from commit 0cc27417f2)

Co-authored-by: toonarmycaptain <toonarmycaptain@hotmail.com>
2019-09-11 19:42:09 +02:00
Miss Islington (bot) 075a441fa0
Correct info about "f.read(size)". (GH13852)
In text mode, the "size" parameter indicates the number of characters, not bytes.
(cherry picked from commit faff81c05f)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
2019-09-10 09:02:40 -07:00
Miss Islington (bot) 8990ac0ab0 bpo-37726: Prefer argparse over getopt in stdlib tutorial (GH-15052) (#15069)
(cherry picked from commit 2491134029)

Co-authored-by: mental <m3nta1@yahoo.com>
2019-08-01 07:35:20 -07:00
Miss Islington (bot) 6f5574866c
Doc: Fix: Proper UpperCamelCase and lowercase. (GH-14644)
Initial report by Michael Blankenship on docs@
(cherry picked from commit 2da622ff77)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-07-08 14:13:59 -07:00
Steve Dower 7b8a449d19
Improve Windows commands in tutorial (GH-14401) 2019-06-26 10:00:58 -07:00
Miss Islington (bot) cee95fe182
bpo-36739: Update controlflow.rst (GH-12983)
in addition to global-statement also mention nonlocal-statement
(in the paragraph describing access to variables which are non local to a function
(cherry picked from commit e1f95e77e0)

Co-authored-by: pbhd <p-bauer-schriesheim@t-online.de>
2019-05-28 20:48:12 -07:00
Miss Islington (bot) 95b7706a95
Doc: Add missing forward reference in the tutorial. (GH-13499)
(cherry picked from commit 51ddab8dae)

Co-authored-by: Julien Palard <julien@palard.fr>
2019-05-28 06:20:58 -07:00
Miss Islington (bot) 5edd82c806 Add a footnote about Cheese Shop in Doc/tutorial (GH-13103) (GH-13174)
(cherry picked from commit e19a91e45f)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2019-05-07 21:59:20 +01:00
Miss Islington (bot) 2b5ffc02c0 bpo-36189: Fixing typo in tutorial introduction (GH-13093)
(cherry picked from commit 98a1e06c47)

Co-authored-by: Jonatan <jonyucra@gmail.com>
2019-05-04 23:22:34 -04:00
Miss Islington (bot) 4b5340bb63
closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. (GH-13008)
(cherry picked from commit ee0309f3d8)

Co-authored-by: Utkarsh Gupta <guptautkarsh2102@gmail.com>
2019-04-29 19:26:00 -07:00
Miss Islington (bot) 59fd08c25c
better __init__.py explanation in tutorial (GH-12763)
* better __init__.py explanation in tutorial

* Update Doc/tutorial/modules.rst

Co-Authored-By: methane <songofacandy@gmail.com>
(cherry picked from commit 5410d3d283)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2019-04-10 23:16:34 -07:00
Miss Islington (bot) e16599c48c
Minor doc improvement (GH-10341)
Change "star-operator" to "* operator".
(cherry picked from commit dfd775a0b1)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2019-03-26 18:23:54 -07:00
Miss Islington (bot) 4d5f1a4bb9
[3.7] Replace "DOS box" with link to Windows FAQ. (GH-12390) (GH-12525)
(cherry picked from commit 6661c1720e)


Co-authored-by: Ned Deily <nad@python.org>
2019-03-24 12:12:05 -07:00
Miss Islington (bot) bc64123335 bpo-35566: Add links to annotation glossary term (GH-11291) (GH-11302) 2018-12-23 21:18:39 -08:00
Serhiy Storchaka 1e47fbcf78
[3.7] bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174). (GH-11232)
(cherry picked from commit 2b57c43f21)
2018-12-19 09:28:12 +02:00
Miss Islington (bot) b949f74f4b
Add a reference to the name mangling description in the tutorial to the index. (GH-10138)
(cherry picked from commit c5eec4426d)

Co-authored-by: Andrés Delfino <adelfino@gmail.com>
2018-11-07 10:29:58 -08:00
Miss Islington (bot) 133fd6527d
Fix a typo about a comma. (GH-10306)
(cherry picked from commit fe62d877e3)

Co-authored-by: İsmail Arılık <arilik.ismail@gmail.com>
2018-11-03 10:41:38 -07:00
Serhiy Storchaka b183750f99
[3.7] bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231). (GH-10253)
(cherry picked from commit 3f819ca138)
2018-10-31 11:00:24 +02:00
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