Commit Graph

129 Commits

Author SHA1 Message Date
Miss Islington (bot) bc055a21cc
[3.11] Resolve reference warnings in faq/programming.rst (GH-108150) (#108171)
Resolve reference warnings in faq/programming.rst (GH-108150)
(cherry picked from commit a390ec20f5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 14:01:24 +00:00
Rafael Fontenelle 5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Fix redirected permanently URLs (#104001)
2023-05-02 14:50:16 +03:00
Miss Islington (bot) 4aeae28671
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:45:42 -08:00
Miss Islington (bot) de621281ce
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:45:45 -08:00
Miss Islington (bot) 1fa4c6bd1f
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:12 -08:00
Miss Islington (bot) b31b64570a
gh-84522: Add for-loop to apply-method-to-sequence FAQ (GH-94660)
(cherry picked from commit 97c493dd35)

Co-authored-by: Samuel Sloniker <sam@kj7rrv.com>
2022-11-10 20:26:31 -08:00
Miss Islington (bot) d683bcc7d0
gh-96265: Formatting changes for faq/programming (GH-98242)
* 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

(cherry picked from commit 0689b99bb8)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-01 22:06:26 -07:00
Miss Islington (bot) c62be23f04
gh-97709: Included newline separator in Mandelbrot set (GH-97737)
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-03 22:43:00 -07:00
Miss Islington (bot) dfe23ee20f
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:37 -07:00
Miss Islington (bot) 4d1de87042
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:45 -07:00
Miss Islington (bot) 8e2bda8227
GH-96851: Add link to FAQ entry for caching method calls. (GH-96902)
(cherry picked from commit bbc24b2bd5)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2022-09-18 15:53:31 -07:00
Miss Islington (bot) c521c5cdc3
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:11 -07:00
Serhiy Storchaka d8df7e0207
[3.11] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95643)
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 11:45:03 +03:00
Miss Islington (bot) 77bf973930
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557)
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:19 +02:00
Irit Katriel 575997af62
[3.11] gh-85023: [doc] clarify parameters vs arguments explanation in FAQ (GH-94282) (GH-94311)
(cherry picked from commit d71f5adc41)

Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com>

Co-authored-by: Arun Mani J <49952138+arun-mani-j@users.noreply.github.com>
2022-06-26 23:00:52 +01:00
Miss Islington (bot) 63e127f33d
gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94076)
(cherry picked from commit f62ff97f31)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-21 21:06:05 +02:00
Matt Harding 2a7efa3242
Fix typo in Programming FAQ (#92083)
I believe the word "with" was missing here.
2022-05-02 09:01:03 -06:00
Raymond Hettinger f4b328e2bb
Clarify that this sentence applies to the above example. GH-32405 2022-04-07 21:10:00 -05:00
Cooper Lees ff5a167597
Fix a typo in Doc/faq/programming.rst (GH-31243)
is not longer used -> is no longer used
2022-02-14 10:49:28 -08:00
Scott Noyes 0d29e7a06f
Fix minor grammar error (#31325)
"an" followed by consonant should be "a"
2022-02-14 10:45:48 -08:00
JMcB bc2bc0dbdb
bpo-45846: Fix capitalisation of Van Rossum at the start of sentence (GH-29641) 2021-11-20 11:35:39 +02:00
Terry Jan Reedy 380c440875
bpo-20692: Add Programming FAQ entry for 1.__class__ error. (GH-28918)
To avoid error, add either space or parentheses.
2021-10-13 01:14:58 -04:00
Raymond Hettinger eec340ea3a
bpo-4442: Document use of __new__ for subclasses of immutable types (GH-27866) 2021-08-22 21:27:06 +02:00
Raymond Hettinger e5c7ee1156
Remove dubious suggestion (GH-26789)
Remove the weakref example.  If a new instance is created and the same arguments are passes, it raises a ReferenceError.
2021-06-18 19:19:32 -05:00
Raymond Hettinger 7f01f77f8f
bpo-44310: Add a FAQ entry for caching method calls (GH-26731) 2021-06-17 15:39:42 -05:00
Erlend Egeberg Aasland 2a1e6698b1
bpo-30757: Improve "How to make stand-alone binaries" FAQ (GH-26309)
Co-authored-by: denfromufa <denfromufa@users.noreply.github.com>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-05-22 23:03:09 +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