◐ Shell
reader mode source ↗
Skip to content

gh-96265: Fix some formatting in faq/design.rst#96924

Merged
ambv merged 8 commits into
python:mainfrom
slateny:s/96265
Oct 7, 2022
Merged

gh-96265: Fix some formatting in faq/design.rst#96924
ambv merged 8 commits into
python:mainfrom
slateny:s/96265

Conversation

@slateny

@slateny slateny commented Sep 19, 2022 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 19, 2022
@ezio-melotti ezio-melotti self-assigned this Sep 19, 2022
slateny and others added 2 commits September 19, 2022 02:50
@slateny
Use links instead of literal
c300f88
@slateny @ezio-melotti
Add back quotes …
a96893a 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
CAM-Gerlach
CAM-Gerlach reviewed Sep 19, 2022
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

By the way, this is a great example of what Diataxis calls an Explanation.

While you're at it, some existing ref targets are broken that you might want to fix, which look to be due to being annotated as methods, but the class (e.g. object or list) is not included. If you change them from e.g. :meth:`__init__` to :meth:`~object.__init__` they should display the same, but resolve correctly.

List of broken ref targets 
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\design.rst:127: WARNING: py:meth reference target not found: __init__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\design.rst:498: WARNING: py:meth reference target not found: __eq__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\design.rst:498: WARNING: py:meth reference target not found: __hash__
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\design.rst:581: WARNING: py:meth reference target not found: append
C:\Users\C. A. M. Gerlach\Documents\dev\Python\cpython\test\Doc\faq\design.rst:581: WARNING: py:meth reference target not found: append

Somewhat related: #95976

ezio-melotti
ezio-melotti approved these changes Sep 21, 2022
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Two minor nits, otherwise LGTM.

slateny and others added 3 commits September 22, 2022 02:10
@slateny
Use list.append instead of append, if-else -> if/else
399564c
@slateny @ezio-melotti
Wrap long line …
e110dd1 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
@slateny @CAM-Gerlach
Remove literal from big-O …
ce33989 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@ambv ambv merged commit 3a7e955 into python:main Oct 7, 2022
@slateny slateny deleted the s/96265 branch October 8, 2022 15:22
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch …
27a4980 
* main: (38 commits)
  pythongh-92886: make test_ast pass with -O (assertions off) (pythonGH-98058)
  pythongh-92886: make test_coroutines pass with -O (assertions off) (pythonGH-98060)
  pythongh-57179: Add note on symlinks for os.walk (python#94799)
  pythongh-94808: Fix regex on exotic platforms (python#98036)
  pythongh-90085: Remove vestigial -t and -c timeit options (python#94941)
  pythonGH-83901: Improve Signature.bind error message for missing keyword-only params (python#95347)
  pythongh-61105: Add default param, note on using cookiejar subclass (python#95427)
  pythongh-96288: Add a sentence to `os.mkdir`'s docstring. (python#96271)
  pythongh-96073: fix backticks in NEWS entry (pythonGH-98056)
  pythongh-92886: [clinic.py] raise exception on invalid input instead of assertion (pythonGH-98051)
  pythongh-97997: Add col_offset field to tokenizer and use that for AST nodes (python#98000)
  pythonGH-88968: Reject socket that is already used as a transport (python#98010)
  pythongh-96346: Use double caching for re._compile() (python#96347)
  pythongh-91708: Revert params note in urllib.parse.urlparse table (python#96699)
  pythongh-96265: Fix some formatting in faq/design.rst (python#96924)
  pythongh-73196: Add namespace/scope clarification for inheritance section (python#92840)
  pythongh-97646: Change `.js` and `.mjs` files mimetype to conform to RFC 9239 (python#97934)
  pythongh-97923: Always run Ubuntu SSL tests with others in CI (python#97940)
  pythongh-97956: Mention `generate_global_objects.py` in `AC How-To` (python#97957)
  pythongh-96959: Update HTTP links which are redirected to HTTPS (python#98039)
  ...
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@slateny @ezio-melotti
@CAM-Gerlach @mpage
pythongh-96265: Fix some formatting in faq/design.rst (python#96924) …
53bc2db 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@CAM-Gerlach

CAM-Gerlach commented Oct 16, 2022

Copy link
Copy Markdown
Member

Hey @ezio-melotti is there a reason this one wasn't backported (but the other ones were?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach left review comments

@ezio-melotti ezio-melotti ezio-melotti approved these changes

Assignees

@ezio-melotti ezio-melotti

Labels

docs skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@slateny @CAM-Gerlach @ezio-melotti @ambv @bedevere-bot