Commit graph

124 commits

Author SHA1 Message Date
Miss Islington (bot)
bc3718eb4b
GH-101898: Fix missing term references for hashable definition (GH-101899)
Fix missing term references for hashable definition
(cherry picked from commit 3690688149)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2023-02-14 02:47:49 -08:00
Miss Islington (bot)
97a3e18c88
gh-55688: Add note about ending backslashes for raw strings (GH-94768)
(cherry picked from commit b95b1b3b25)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: hauntsaninja <hauntsaninja@gmail.com>
2022-12-27 21:39:53 -08:00
Miss Islington (bot)
86cdfaa885
gh-48496: Added example and link to faq for UnboundLocalError in reference (GH-93068)
(cherry picked from commit f3db68e6e6)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-12-22 15:30:09 -08:00
Stanley
c592b33977
[3.10] gh-96265: Formatting changes for faq/programming (GH-98242) (#98994)
* Formatting changes for faq/programming

* Add missing method formatting, use non-literal formatting

* Fix sphinx warnings

* Some extra formatting missed earlier

* More formatting suggestions from review

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

* Add missing colon, avoid referening external module

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 0689b99bb8)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-11-03 01:30:12 +01:00
Miss Islington (bot)
19ed29ed3c
[3.10] gh-97709: Included newline separator in Mandelbrot set (GH-97737) (#97823)
Included newline separator in Mandelbrot set

Now the Mandelbrot set one-liner example on separates the lines with a '\n' character.
(cherry picked from commit 49802605f8)

Co-authored-by: matheusja <matheusjahnke@hotmail.com>
2022-10-04 12:01:07 -07:00
Miss Islington (bot)
2e315d87ff
gh-96959: Update more HTTP links (GH-97536)
Use HTTPS for documents which are available by both HTTP and HTTPS
links, but there is no redirection from HTTP to HTTPS or vice versa.
(cherry picked from commit dd53b79de0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-09-27 04:16:23 -07:00
Miss Islington (bot)
437032e313
gh-96959: Update HTTP links which are redirected to HTTPS (GH-96961)
(cherry picked from commit db39050396)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-09-25 01:20:53 -07:00
Miss Islington (bot)
be30a6dc4d
gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)
It updates links which redirect to HTTPS with different authority or
path.
(cherry picked from commit d0d0154443)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-08-04 06:15:01 -07:00
Serhiy Storchaka
54d4b4d992
[3.10] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95644)
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.

This change does not affect Python examples..
(cherry picked from commit f79547a429)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-08-04 12:19:44 +03:00
Łukasz Langa
6e47020d31
[3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558)
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2022-07-05 14:30:37 +02:00
Miss Islington (bot)
fd26f29c29
gh-85023: [doc] clarify parameters vs arguments explanation in FAQ (GH-94282)
(cherry picked from commit d71f5adc41)

Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com>
2022-06-26 15:05:23 -07:00
Łukasz Langa
38fdff9274
[3.10] gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94078)
(cherry picked from commit f62ff97f31)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-21 21:37:09 +02:00
Miss Islington (bot)
864058ba86
[3.10] Fix typo in Programming FAQ (GH-92083) (GH-92148)
I believe the word "with" was missing here.
(cherry picked from commit 2a7efa3242)


Co-authored-by: Matt Harding <majaharding@gmail.com>
2022-05-02 10:24:49 -07:00
Miss Islington (bot)
5574cacf57
Fix minor grammar error (GH-31325)
"an" followed by consonant should be "a"
(cherry picked from commit 0d29e7a06f)

Co-authored-by: Scott Noyes <snoyes@gmail.com>
2022-02-14 11:09:57 -08:00
Miss Islington (bot)
a606c6a350
Fix a typo in Doc/faq/programming.rst (GH-31243)
is not longer used -> is no longer used
(cherry picked from commit ff5a167597)

Co-authored-by: Cooper Lees <me@cooperlees.com>
2022-02-14 11:08:39 -08:00
Miss Islington (bot)
82f1a6edfb
bpo-45846: Fix capitalisation of Van Rossum at the start of sentence (GH-29641) (GH-29656)
(cherry picked from commit bc2bc0dbdb)

Co-authored-by: JMcB <joel.mcbride1@live.com>
2021-11-20 16:57:16 +01:00
Miss Islington (bot)
47673c47db
bpo-20692: Add Programming FAQ entry for 1.__class__ error. (GH-28918)
To avoid error, add either space or parentheses.
(cherry picked from commit 380c440875)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-10-12 22:37:51 -07:00
Miss Islington (bot)
0627918f0b
bpo-4442: Document use of __new__ for subclasses of immutable types (GH-27866)
(cherry picked from commit eec340ea3a)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2021-08-22 12:49:24 -07:00
Miss Islington (bot)
3cb70ab2fb
Remove dubious suggestion (GH-26789) (#26797) 2021-06-18 23:27:47 -05:00
Miss Islington (bot)
77eaf14d27
bpo-44310: Add a FAQ entry for caching method calls (GH-26731) (GH-26777) 2021-06-17 16:14:36 -05:00
Miss Islington (bot)
413df57968
bpo-30757: Improve "How to make stand-alone binaries" FAQ (GH-26309) (GH-26311)
Co-authored-by: denfromufa <denfromufa@users.noreply.github.com>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 2a1e6698b1)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-05-22 23:23:03 +01:00
Andre Delfino
08a4803863
[doc] Do some polishing in IDEs section (GH-22070) 2021-04-28 18:06:53 -07:00
Andre Delfino
d28b346953
Fix broken links and improve stand-alone tools list in FAQ GH-22124 2021-04-25 18:10:05 -07:00
Julien Palard
fd79af7ae2
Doc: Try to enhance wording on circular imports. (GH-24705) 2021-04-13 18:03:22 +02:00
Raymond Hettinger
7bc25ec727
bpo-20503: Show how isinstance() works with ABC registered classes. (GH-25175) 2021-04-05 12:48:24 -07:00
Raymond Hettinger
f8775e4f72
bpo-43325: Add FAQ entry for identity tests (GH-25168) 2021-04-03 19:54:49 -07:00
Andre Delfino
fb2e94692e
Doc: Do not suggest s[::-1] for reversed order (GH-22457) 2020-10-21 17:25:07 +09:00
Andre Delfino
4642ccd1c3
Doc: Do not encourage using a base class name in a derived class (GH-22177) 2020-10-21 14:25:05 +09:00
Zackery Spytz
a22a19f354
bpo-40341: Remove some "discouraged solutions" in Doc/faq/programming.rst (GH-22726) 2020-10-16 11:44:17 -07:00
Terry Jan Reedy
060937da98
bpo-41774: Tweak new programming FAQ entry (GH-22562)
Remove mention of space in "remove multiple items from list".
2020-10-05 10:31:44 -04:00
Andre Delfino
c8bb24166e
[doc] Update references to NumPy (GH-22458)
Numeric(al) Python to NumPy. It seems the old name hasn't been used for some time.
2020-10-01 16:22:14 -07:00
Terry Jan Reedy
5b0181d1f6
bpo-41774: Add programming FAQ entry (GH-22402)
In the "Sequences (Tuples/Lists)" section, add
"How do you remove multiple items from a list".
2020-09-29 01:02:44 -04:00
Andre Delfino
e8a2076e14
Revert "Fix all Python Cookbook links (#22205)" (GH-22424)
This commit reverts commit ac0333e1e1 as the original links are working again and they provide extended features such as comments and alternative versions.
2020-09-27 01:47:25 +01:00
Andre Delfino
778ad926cb
[doc] Teach 0-args form of super in Programming FAQ (GH-22176) 2020-09-20 10:09:50 -07:00
Andre Delfino
ac0333e1e1
Fix all Python Cookbook links (#22205) 2020-09-15 21:13:26 +01:00
Andre Delfino
1d25f5bf7b
Remove reference to Boa Constructor. (GH-22012) 2020-09-01 22:22:55 -05:00
Andre Delfino
dea82b6731
[doc] Remove references to PyChecker. (GH-22011) 2020-09-01 22:21:12 -05:00
Jiajie Zhong
67acf74c4e
Doc: Add output to example code in programming FAQ (GH-21346)
Add output hint to document, part faq/programming, section [How do I write a function with output parameters (call by reference)?](https://docs.python.org/3/faq/programming.html#how-do-i-write-a-function-with-output-parameters-call-by-reference).

This patch make the output hint just like prefix code block.
2020-08-08 12:29:03 -07:00
Zackery Spytz
caf1aadf3d
bpo-40348: Fix typos in the programming FAQ (GH-19729) 2020-04-26 20:23:52 -07:00
Cajetan Rodrigues
5aafa54879
bpo-40340: Separate examples more clearly in the programming FAQ (GH-19688) 2020-04-24 19:39:04 -04:00
Gurupad Hegde
6c7bb38ff2 bpo-39136: Fixed typos (GH-17720)
funtion -> function; configuraton -> configuration; defintitions -> definitions;
focusses -> focuses; necesarily -> necessarily; follwing -> following;
Excape -> Escape,
2019-12-28 17:16:02 -05:00
Ammar Askar
87d6cd3604 bpo-38237: Make pow's arguments have more descriptive names and be keyword passable (GH-16302)
Edit: `math.pow` changes removed on Mark's request.


https://bugs.python.org/issue38237



Automerge-Triggered-By: @rhettinger
2019-09-20 21:28:49 -07:00
avinassh
3aa48b88c7 bpo-36167: fix an incorrect capitalization (GH-14482) 2019-08-29 01:40:50 -04:00
Terry Jan Reedy
6f2a8c0857
bpo-37456: Slash ('/') is now part of syntax. (GH-14627) 2019-07-06 18:13:02 -04:00
Serhiy Storchaka
70c5f2ae6e
Use more PEP 570 syntax in the documentation. (GH-13720) 2019-06-01 11:38:24 +03:00
Xtreak
9b5a0efcdc Fix typos in documentation (#13344) 2019-05-16 00:34:24 -04:00
Andre Delfino
cf48e55f7f bpo-33882: mention breakpoint() in debugger-related FAQ (GH-7759) 2019-05-03 12:53:21 -04:00
Lysandros Nikolaou
1aeeaeb79e bpo-21314: Add a FAQ entry about positional only parameters (GH-10641) 2019-03-10 21:30:11 +10:00
Andre Delfino
55e335d7d5 Remove empty Dictionaries section from programming FAQ (GH-12026) 2019-02-25 11:22:07 -05:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174) 2018-12-19 08:09:46 +02:00