Skip to content

fix errors in docstrings #157

@schmouk

Description

@schmouk
  • There still remains erroneous doc in docstrings about rand(a, b) explanations. Remove all these lines. (OK)
  • See also mentions of Well19937b and Well44497c for which suffix letter 'b' and 'c' should be exchanged. (OK)
  • randmoness --> randomness also. (OK)
  • _ at end of perfs tables in docstrings also. (|_ --> |). (OK)
  • in squares64.py, replace "This Squares models is based on a four rounds of squaring and" four --> five. (OK)
  • in basepcg.py, fix typo
        x(i-1): x(i) = (a*x(i-1) + c) mod m ```
    

( x(i-1): should be put in upper line). Modify also the surrounding text which would benefit of enhancements. (OK)

  • All PCGs specializations: modify head docstring content. (OK)
  • for PCGs, modify "equistributed" with "equidistributed". (OK)
  • for all MELG modules, replace 626 with 625 (Melg19937) and fix value of decimal period of Melg44497 with 8.55e+13,395. (OK)
  • in modules CWG, verify the correctness of output bits in comments and the correctness of internal state bits also. (OK)
  • in module cwg64.py, verify the correctness of 64 vs. 128 bits of attribute _state! (OK)
  • in modules cwgxx.py, fix length of docstrings in first paragraphs. (OK)
  • in ALL modules, remove the mention of diceroll(1, 7) which is no more used this way. (OK)
  • fix erroneous e-mail address (schmouk --> ph.schmouker). (OK)
  • Fix erroneous comment in Squares64.py: output values are returned on 64-bits, not 32-bits. (OK)
  • Fix erroneous PRNG class namings in docstrings. (OK)
  • in README.md, add (self, ... at any missing place in the last section of the file - for instance, at: choices(population, weights=None, *, cum_weights=None, k=1). (OK)
  • in README.md, exchange columns in 'randomness evaluation' to get Crush tests results before time consumed by algos. (OK)

Sub-issues

Metadata

Metadata

Assignees

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions