gh-96265: Formatting changes for faq/programming #98242

slateny · 2022-10-13T15:49:38Z

https://docs.python.org/dev/faq/programming.html

Issue: Improve faq/design.rst rst markup #96265

Doc/faq/programming.rst

CAM-Gerlach

Thanks. Could you also fix the warnings? Some of them I address below and the rest are similar to before, e.g. :meth:`__del__` when they should be :meth:`~object.__del__`, and the rest are correct, but the targets just don't exist as they should yet, and will be fixed as discussed in #86272.

List of warnings

C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:455: WARNING: py:meth reference target not found: list.append
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1017: WARNING: c:func reference target not found: sscanf
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1342: WARNING: py:meth reference target not found: __iadd__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1342: WARNING: py:meth reference target not found: list.extend
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1342: WARNING: py:meth reference target not found: list.extend
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1373: WARNING: py:meth reference target not found: __iadd__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1550: WARNING: py:meth reference target not found: __setattr__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1561: WARNING: py:meth reference target not found: __setattr__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1699: WARNING: py:meth reference target not found: __del__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1703: WARNING: py:meth reference target not found: __del__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1703: WARNING: py:meth reference target not found: __del__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1714: WARNING: py:meth reference target not found: __del__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1714: WARNING: py:meth reference target not found: __del__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1734: WARNING: py:meth reference target not found: __del__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\programming.rst:1849: WARNING: py:meth reference target not found: collections.abc.Sequence.__contains__

Doc/faq/programming.rst

CAM-Gerlach

A few more minor tweaks, some more than possibilities than anything, otherwise LGTM

Doc/faq/programming.rst

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

CAM-Gerlach

LGTM, thanks @slateny

slateny · 2022-10-16T20:40:11Z

LGTM, thanks @slateny

Thanks for the detailed reviews too!

slateny · 2022-11-02T04:52:40Z

@ezio-melotti Could you take a peek at this one? I think it should be good to go

miss-islington · 2022-11-02T04:58:48Z

Thanks @slateny for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington · 2022-11-02T04:58:54Z

Sorry, @slateny and @ezio-melotti, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 0689b99bb8c4f6058af43a52effaa8a25609dbed 3.10

* 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 0689b99) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

bedevere-bot · 2022-11-02T04:58:59Z

GH-98991 is a backport of this pull request to the 3.11 branch.

miss-islington · 2022-11-02T05:01:33Z

Thanks @slateny for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington · 2022-11-02T05:01:34Z

Sorry @slateny and @ezio-melotti, I had trouble checking out the 3.10 backport branch.
Please retry by removing and re-adding the "needs backport to 3.10" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 0689b99bb8c4f6058af43a52effaa8a25609dbed 3.10

* 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 0689b99) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

…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 Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 0689b99) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

bedevere-bot · 2022-11-02T05:38:21Z

GH-98994 is a backport of this pull request to the 3.10 branch.

…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 0689b99) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

merwok · 2023-07-13T12:38:47Z

Doc/faq/programming.rst

@@ -273,7 +278,7 @@ main.py::
   import mod
   print(config.x)

-Note that using a module is also the basis for implementing the Singleton design
+Note that using a module is also the basis for implementing the singleton design


This change was not useful: classic design patterns are commonly title cased.
But not worth changing back now.

Formatting changes for faq/programming

8f40dcb

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 13, 2022

slateny commented Oct 13, 2022

View reviewed changes

Doc/faq/programming.rst Show resolved Hide resolved

slateny requested review from CAM-Gerlach and ezio-melotti October 13, 2022 15:53

Add missing method formatting, use non-literal formatting

85796a8

CAM-Gerlach reviewed Oct 13, 2022

View reviewed changes

slateny added 2 commits October 15, 2022 15:15

Fix sphinx warnings

9112b9f

Some extra formatting missed earlier

522a879

CAM-Gerlach reviewed Oct 16, 2022

View reviewed changes

CAM-Gerlach added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 16, 2022

slateny and others added 2 commits October 16, 2022 06:27

More formatting suggestions from review

cbcfa09

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

Add missing colon, avoid referening external module

37dacbe

CAM-Gerlach approved these changes Oct 16, 2022

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Oct 16, 2022

ezio-melotti merged commit 0689b99 into python:main Nov 2, 2022

bedevere-bot removed the awaiting core review label Nov 2, 2022

miss-islington assigned ezio-melotti Nov 2, 2022

bedevere-bot removed the needs backport to 3.11 only security fixes label Nov 2, 2022

ezio-melotti removed the needs backport to 3.10 only security fixes label Nov 2, 2022

ezio-melotti added the needs backport to 3.10 only security fixes label Nov 2, 2022

slateny deleted the s/96265-programming branch November 2, 2022 05:19

bedevere-bot removed the needs backport to 3.10 only security fixes label Nov 2, 2022

merwok reviewed Jul 13, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-96265: Formatting changes for faq/programming #98242

gh-96265: Formatting changes for faq/programming #98242

slateny commented Oct 13, 2022 •

edited by bedevere-bot

CAM-Gerlach left a comment

CAM-Gerlach left a comment

CAM-Gerlach left a comment

slateny commented Oct 16, 2022

slateny commented Nov 2, 2022

miss-islington commented Nov 2, 2022

miss-islington commented Nov 2, 2022

bedevere-bot commented Nov 2, 2022

miss-islington commented Nov 2, 2022

miss-islington commented Nov 2, 2022

bedevere-bot commented Nov 2, 2022

merwok Jul 13, 2023

gh-96265: Formatting changes for faq/programming #98242

gh-96265: Formatting changes for faq/programming #98242

Conversation

slateny commented Oct 13, 2022 • edited by bedevere-bot

CAM-Gerlach left a comment

Choose a reason for hiding this comment

CAM-Gerlach left a comment

Choose a reason for hiding this comment

CAM-Gerlach left a comment

Choose a reason for hiding this comment

slateny commented Oct 16, 2022

slateny commented Nov 2, 2022

miss-islington commented Nov 2, 2022

miss-islington commented Nov 2, 2022

bedevere-bot commented Nov 2, 2022

miss-islington commented Nov 2, 2022

miss-islington commented Nov 2, 2022

bedevere-bot commented Nov 2, 2022

merwok Jul 13, 2023

Choose a reason for hiding this comment

slateny commented Oct 13, 2022 •

edited by bedevere-bot