Skip to content

references to Random module in the Julia manual #26853

Closed
@bkamins

Description

Currently in several places of the Julia Manual random number generation is used in examples. We require explicit using Random for those examples to work (now it will throw deprecation warning but in Julia 1.0 those examples will throw an error).

This means that novice Julia users when trying to copy-paste an example will not understand why it fails.

There are three possible solutions:

  1. in the introduction to the manual explicitly discuss this issue and leave the manual as-is;
  2. add using Random in the examples where needed to make them work stand alone;
  3. do nothing (I would not recommend this).

My personal preference would be option 2 (adding using Random where needed to the examples - the downside is adds a bit of noise to the examples), but maybe there are other opinions.

I will make a PR with the appropriate changes when I we have an opinion.

Metadata

Assignees

No one assigned

    Labels

    docsThis change adds or pertains to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions