gh-96265: Formatting changes for faq/programming #98242
Merged
+48
−39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slateny
commented
Oct 13, 2022
CAM-Gerlach
reviewed
Oct 13, 2022
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__
CAM-Gerlach
reviewed
Oct 16, 2022
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Thanks for the detailed reviews too! |
|
@ezio-melotti Could you take a peek at this one? I think it should be good to go |
|
Thanks @slateny for the PR, and @ezio-melotti for merging it |
|
Sorry, @slateny and @ezio-melotti, I could not cleanly backport this to |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 2, 2022
* 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-98991 is a backport of this pull request to the 3.11 branch. |
|
Thanks @slateny for the PR, and @ezio-melotti for merging it |
|
Sorry @slateny and @ezio-melotti, I had trouble checking out the |
miss-islington
added a commit
that referenced
this pull request
Nov 2, 2022
* 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>
slateny
added a commit
to slateny/cpython
that referenced
this pull request
Nov 2, 2022
…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>
|
GH-98994 is a backport of this pull request to the 3.10 branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
https://docs.python.org/dev/faq/programming.html
faq/design.rstrst markup #96265