8000 Docs: format sys.float_info properly by erlend-aasland · Pull Request #108107 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Docs: format sys.float_info properly #108107

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Aug 19, 2023
Merged

Docs: format sys.float_info properly #108107

merged 4 commits into from
Aug 19, 2023

Conversation

erlend-aasland
Copy link
Contributor
@erlend-aasland erlend-aasland commented Aug 18, 2023 •
edited
Loading
  • Normalise capitalisation and punctuation
  • Use .. attribute:: markup for named tuple attributes
  • Use :c:macro: markup for C macros
  • Use a list for the 'rounds' attribute values
  • Use list-table, for better .rst readability

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

@erlend-aasland
Docs: format sys.float_info properly
3e8faf3 
- Normalise capitalisation and punctuation
- Use :attr: markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Aug 18, 2023
@erlend-aasland
Copy link
Contributor Author

I really like the list-table markup.

AA-Turner
AA-Turner reviewed Aug 18, 2023
View reviewed changes
@rhettinger rhettinger requested a review from mdickinson August 18, 2023 17:01
@rhettinger
Copy link
Contributor

Perhaps also mention subnormals because this was a point of confusion in the past: #93488

@rhettinger
Copy link
Contributor

Also see the comments and edits in #85988

@AA-Turner AA-Turner mentioned this pull request Aug 18, 2023
Merged
@AA-Turner
Copy link
Member

Perhaps also mention subnormals

This PR is just about re-formatting the table such that it reads better, so I think adding any major new content would be out-of-scope? Will defer to Erlend, though.

A

@mdickinson
Copy link
Member

+1 for the formatting changes; agreed that we can tweak the content if necessary in a separate PR.

@erlend-aasland
Copy link
Contributor Author

Perhaps also mention subnormals

This PR is just about re-formatting the table such that it reads better, so I think adding any major new content would be out-of-scope? Will defer to Erlend, though.

Definitely; content changes are out of scope for this PR.

I'll add your Sphinx suggestions before landing.

Thanks for chiming in, y'all.

erlend-aasland and others added 2 commits August 19, 2023 09:52
@erlend-aasland @AA-Turner
Apply suggestions from code review
3829beb 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@erlend-aasland
Remove one unneeded link
eb7afd9
@erlend-aasland erlend-aasland enabled auto-merge (squash) August 19, 2023 07:56
@erlend-aasland erlend-aasland enabled auto-merge (squash) August 19, 2023 07:56
@erlend-aasland erlend-aasland enabled auto-merge (squash) August 19, 2023 07:57
@erlend-aasland erlend-aasland merged commit ca0c6c1 into python:main Aug 19, 2023
@miss-islington
Copy link
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-108130 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Aug 19, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 19, 2023
@erlend-aasland @AA-Turner @miss-islington
Docs: format sys.float_info properly (pythonGH-108107)
c28a171 
- Normalise capitalisation and punctuation
- Use attribute markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
- Remove one unneeded sys.float_info.dig link

(cherry picked from commit ca0c6c1)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 19, 2023
@erlend-aasland @AA-Turner @miss-islington
Docs: format sys.float_info properly (pythonGH-108107)
745dcf0 
- Normalise capitalisation and punctuation
- Use attribute markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
- Remove one unneeded sys.float_info.dig link

(cherry picked from commit ca0c6c1)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 19, 2023
AlexWaygood pushed a commit that referenced this pull request Aug 19, 2023
@miss-islington @erlend-aasland @AA-Turner
[3.11] Docs: format sys.float_info properly (GH-108107) (#108131)
0673d4c 
Docs: format sys.float_info properly (GH-108107)

- Normalise capitalisation and punctuation
- Use attribute markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
- Remove one unneeded sys.float_info.dig link

(cherry picked from commit ca0c6c1)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@erlend-aasland erlend-aasland deleted the docs/sys.rst-floatinfo-table branch August 19, 2023 11:11
Yhg1s pushed a commit that referenced this pull request Aug 19, 2023
@miss-islington @erlend-aasland @AA-Turner
[3.12] Docs: format sys.float_info properly (GH-108107) (#108130)
2807430 
Docs: format sys.float_info properly (GH-108107)

- Normalise capitalisation and punctuation
- Use attribute markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
- Remove one unneeded sys.float_info.dig link

(cherry picked from commit ca0c6c1)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner AA-Turner left review comments

@mdickinson mdickinson mdickinson approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@erlend-aasland @rhettinger @AA-Turner @mdickinson @miss-islington @bedevere-bot @AlexWaygood
0