Skip to content

Modify quick start documentation to fit common use case #1778

@alpitol

Description

@alpitol

Was trying to use this crate, and found the documentation a bit awkward. Mainly, I think the most common use cases to generate random variables are to

  • generate random integer on a range
  • generate random float on range 0-1.

So I think they should be main examples in "Quick Start" section in the crate documentation. The current advanced examples in the Quick Start should be moved to the book. The Quick Start could be added to the readme.md too, so that it is visible on the github page. Also, glob imports may be undesired for many, so better if the example could avoid using them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions