Skip to content

gh-135244: improve wording of uuid8 docs about CSPRNG #135433

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
Jun 13, 2025

Conversation

LamentXU123
Copy link
Contributor

@LamentXU123 LamentXU123 commented Jun 12, 2025

This PR is a tiny fix of #135226

By default, a, b and c are generated by a non-cryptographically
secure pseudo-random number generator (CSPRNG). Use :func:uuid4 when
a UUID needs to be used in a security-sensitive context.

Well IMO, to avoid ambiguity, it may be changed to

By default, a, b and c are not generated by a cryptographically
secure pseudo-random number generator (CSPRNG). Use :func:uuid4 when
a UUID needs to be used in a security-sensitive context.

caz the term "CSPRNG" stands for "cryptographically secure pseudo-random number generator" not "non-cryptographically secure pseudo-random number generator".

Could be kind of dumb caz I'm not a English native speaker lol. But I think its a little weird about the original presentation.

I've mentioned this in a deleted comment of #135244, nvm. Skipping news and issue caz this is a tiny fix in doc. Thank u for ur time @picnixz.


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

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jun 12, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jun 12, 2025
@LamentXU123 LamentXU123 changed the title Fix presentation in doc of uuid8 about CSPRNG #135244 Fix presentation in doc of uuid8 about CSPRNG Jun 12, 2025
@LamentXU123 LamentXU123 changed the title #135244 Fix presentation in doc of uuid8 about CSPRNG Fix presentation in doc of uuid8 about CSPRNG Jun 12, 2025
@picnixz
Copy link
Member

picnixz commented Jun 13, 2025

I'll review it this evening

@picnixz picnixz changed the title Fix presentation in doc of uuid8 about CSPRNG gh-135244: improve wording of uuid8 docs about CSPRNG Jun 13, 2025
@picnixz picnixz merged commit 394d798 into python:main Jun 13, 2025
45 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jun 13, 2025
@miss-islington-app
Copy link

Thanks @LamentXU123 for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 13, 2025
…GH-135433)

(cherry picked from commit 394d798)

Co-authored-by: LamentXU <108666168+LamentXU123@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 13, 2025

GH-135467 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jun 13, 2025
@picnixz
Copy link
Member

picnixz commented Jun 13, 2025

We don't need a 3.13 backport because UUIDv8 has only been introduced in 3.14.

@LamentXU123
Copy link
Contributor Author

We don't need a 3.13 backport because UUIDv8 has only been introduced in 3.14.

sure. Nice work.

picnixz pushed a commit that referenced this pull request Jun 13, 2025
…5433) (#135467)

gh-135244: improve wording of `uuid8` docs about CSPRNG (GH-135433)
(cherry picked from commit 394d798)

Co-authored-by: LamentXU <108666168+LamentXU123@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
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants