Skip to content

gh-123392: Clarify wording regarding parameters that are functions to be called#123394

Merged
encukou merged 3 commits into
python:mainfrom
ryan-duve:fix-issue-123392
Sep 4, 2024
Merged

gh-123392: Clarify wording regarding parameters that are functions to be called#123394
encukou merged 3 commits into
python:mainfrom
ryan-duve:fix-issue-123392

Conversation

@ryan-duve

@ryan-duve ryan-duve commented Aug 27, 2024

Copy link
Copy Markdown
Contributor

Fix for #123392 to clarify wording on callable parameters in documentation.


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

picnixz
picnixz previously approved these changes Aug 27, 2024

@picnixz picnixz 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.

I think this is good because that's how object_pairs_hook and object_hook are documented. Well, personally I would have kept the current wording and only updated those two but I don't mind to be a bit more verbose if needed.

Comment thread Doc/library/json.rst Outdated
@picnixz picnixz dismissed their stale review August 27, 2024 14:28

Just waiting for the changes to be done before accepting.

@picnixz picnixz 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.

One last nitpick: we wrap lines at 80 chars. I don't know whether the RST is now more than 80 chars wide or not but if it's the case, can you make the RST fit on 80 characters? (be careful that your lines do not have trailing whitespaces).

@ryan-duve

Copy link
Copy Markdown
Contributor Author

One last nitpick: we wrap lines at 80 chars. I don't know whether the RST is now more than 80 chars wide or not but if it's the case, can you make the RST fit on 80 characters? (be careful that your lines do not have trailing whitespaces).

Hey @picnixz -- sure thing, nitpicks welcome! I made the change in da35e8b. Let me know if you see any other way to improve the PR.

@ryan-duve ryan-duve requested a review from picnixz August 29, 2024 18:42

@picnixz picnixz 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.

I think it's good unless I missed an obvious typo.

@encukou encukou added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Sep 4, 2024
@encukou encukou enabled auto-merge (squash) September 4, 2024 11:04
@encukou encukou merged commit c08ede2 into python:main Sep 4, 2024
@miss-islington-app

Copy link
Copy Markdown

Thanks @ryan-duve for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 4, 2024
…ons to be called (pythonGH-123394)

(cherry picked from commit c08ede2)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Sep 4, 2024

Copy link
Copy Markdown

GH-123664 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Sep 4, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 4, 2024
…ons to be called (pythonGH-123394)

(cherry picked from commit c08ede2)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Sep 4, 2024

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Sep 4, 2024
encukou pushed a commit that referenced this pull request Sep 5, 2024
…ions to be called (GH-123394) (GH-123664)

(cherry picked from commit c08ede2)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
encukou pushed a commit that referenced this pull request Sep 5, 2024
…ions to be called (GH-123394) (GH-123665)

(cherry picked from commit c08ede2)

Co-authored-by: ryan-duve <ryan-duve@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants