Skip to content

Improve the deprecation of crypto:rand_uniform/2 #10344

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
Open
wants to merge 5 commits into
base: maint
Choose a base branch
from
Open

Improve the deprecation of crypto:rand_uniform/2 #10344

wants to merge 5 commits into from

Conversation

@RaimoNiskanen
Copy link
Contributor

@RaimoNiskanen RaimoNiskanen commented Nov 3, 2025

This PR improves the documentation to clarify how to use the crypto plug-in generator(s) in rand in a safe manner.

While at it I also (hopefully) improved the overview section in the rand documentation a bit.

@RaimoNiskanen RaimoNiskanen added this to the 28.2 milestone Nov 3, 2025
@RaimoNiskanen RaimoNiskanen self-assigned this Nov 3, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025 •
edited
Loading

CT Test Results

    3 files    100 suites   1h 11m 59s ⏱️
2 308 tests 2 243 ✅  65 💤 0 ❌
2 969 runs  2 774 ✅ 195 💤 0 ❌

Results for commit 68c0064.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

@RaimoNiskanen RaimoNiskanen requested a review from dgud November 3, 2025 17:14
dgud
dgud reviewed Nov 3, 2025
View reviewed changes
dgud
dgud reviewed Nov 4, 2025
View reviewed changes
Maria-12648430
Maria-12648430 suggested changes Nov 4, 2025
View reviewed changes
matthiasl
matthiasl reviewed Nov 4, 2025
View reviewed changes
bjorng
bjorng reviewed Nov 5, 2025
View reviewed changes
@RaimoNiskanen
Copy link
Contributor Author

RaimoNiskanen commented Nov 5, 2025

Updated after feedback. Thank you all!

I also changed the module doc examples to be parsed and test run in our test suites.

@RaimoNiskanen
Copy link
Contributor Author

RaimoNiskanen commented Nov 6, 2025

Moved all the rand functions to a dedicated documentation group, and rephrased the deprecation reason for `crypto:rand_uniform/2.

@RaimoNiskanen
Copy link
Contributor Author

RaimoNiskanen commented Nov 6, 2025

Changed track a bit to exporting and documenting crypto:strong_rand_range/1, and point the deprecation of crypto:rand_uniform/2 to it instead.

All other improvements remain.

@RaimoNiskanen RaimoNiskanen changed the title Improve rand + crypto interaction documentation Improve the deprecation of crypto:rand_uniform/2 Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bjorng bjorng bjorng left review comments

@dgud dgud dgud left review comments

@rickard-green rickard-green Awaiting requested review from rickard-green

+2 more reviewers

@matthiasl matthiasl matthiasl left review comments

@Maria-12648430 Maria-12648430 Maria-12648430 requested changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

@RaimoNiskanen RaimoNiskanen

Labels

enhancement in progress priority:low team:PS Assigned to OTP team PS

Projects

None yet

Milestone

28.2

Development

Successfully merging this pull request may close these issues.

5 participants

@RaimoNiskanen @bjorng @dgud @matthiasl @Maria-12648430