Skip to content

[3.11] Docs: Fix Sphinx warnings in sys.rst (GH-108106) #108166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2023

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Aug 20, 2023

  • Mark up named tuple attributes as attributes
  • Remove links for external functions
  • io.BufferedIOBase has no 'buffer' attribute;
    remove the link and mark up using :attr:!buffer
  • (Re)format some tables as bullet lists:
    • sys._emscripten_info
    • sys.hash_info
    • sys.int_info
    • sys.thread_info
  • In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
    add links to the frame objects reference.

(cherry picked from commit 29fa7af)

Co-authored-by: Erlend E. Aasland [email protected]
Co-authored-by: Alex Waygood [email protected]
Co-authored-by: Adam Turner [email protected]


📚 Documentation preview 📚: https://cpython-previews--108166.org.readthedocs.build/

- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
  remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
  - sys._emscripten_info
  - sys.hash_info
  - sys.int_info
  - sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
  add links to the frame objects reference.

(cherry picked from commit 29fa7af)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@kumaraditya303 kumaraditya303 merged commit 5af34d2 into python:3.11 Aug 20, 2023
@miss-islington miss-islington deleted the backport-29fa7af-3.11 branch August 20, 2023 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants