Skip to content
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

[DOC] Improve Random::Formatter docs #5434

Merged
merged 1 commit into from Dec 11, 2022

Conversation

zverok
Copy link
Contributor

@zverok zverok commented Jan 12, 2022

  • Make its usage more obvious (by providing more detailed examples);
  • Include mention of it into Random itself;
  • Small cleanups of docs.

The docs for the module always left me confused :) They all just show prng.some_method without describing what the prng is and how it all is related to Random.
Trying to make them a bit more friendly.

lib/random/formatter.rb Outdated Show resolved Hide resolved
@hsbt hsbt added the Documentation Improvements to documentation. label Jan 15, 2022
@nobu
Copy link
Member

nobu commented Jan 24, 2022

Would you merge or rebase to fix the OpenSSL failures?

@hsbt hsbt force-pushed the doc-improve-random-formatter-docs branch from 918e4f1 to 873de82 Compare February 23, 2022 02:27
* Make its usage more obvious (by providing more detailed
  examples);
* Include mention of it into Random itself;
* Small cleanups of docs.
@zverok zverok force-pushed the doc-improve-random-formatter-docs branch from 873de82 to 0fd15e2 Compare December 10, 2022 11:13
@zverok zverok merged commit 381a373 into ruby:master Dec 11, 2022
@zverok zverok deleted the doc-improve-random-formatter-docs branch December 11, 2022 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
3 participants