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

Random source are documented in "Integers" chapter; move them? (to a new chapter)? #1057

Open
fingolfin opened this issue Jan 8, 2017 · 3 comments
Labels
kind: discussion discussions, questions, requests for comments, and so on topic: documentation Issues and PRs related to documentation

Comments

@fingolfin
Copy link
Member

Right now, Random source are documented in section 14.17 of the "Integers" chapter. I find that quite counterintuitive and really weird.

So perhaps we should move them to a more appropriate location? Perhaps together with section 30.7 "Random Elements"

But where? Perhaps to a new chapter? But are we willing to insert a new chapter, as that would renumber all following chapters, and break hyperlinks of package manuals... ??

And if we move it to a new chapter, would it be a chapter title "Random", or rather a chapter "Miscellaneous", and we'd move some other things there which are weirdly placed right now (IIRC there are some, but I don't know any from the top of my head).

@fingolfin fingolfin added topic: documentation Issues and PRs related to documentation question labels Jan 8, 2017
@ChrisJefferson
Copy link
Contributor

It is weird. I wonder also if we should document every specialisation of Random, or just the general method.

@fingolfin
Copy link
Member Author

fingolfin commented Jan 9, 2017

@ChrisJefferson See also #116

@fingolfin
Copy link
Member Author

At the very least, it would be good to merge the documentation for Random( listorcoll ) and Random( rs, list ) (into an entry saying Random( [rs, ]listorcoll ), I guess?) and similar for Random( from, to ) and Random( rs, low, high ). Right now, I think neither refers to the other.

Moreover, some of them are defined and documented in coll.gd, the others in random.gd. When merging their documentation, I'd also move their declarations into the same file (preferable random.gd?) and move them together.

And while we are at it, random source arguments should ideally also be added to PseudoRandom and RandomList. Note that the latter is useful as an alternative to Random(list) because it avoids the method selection overhead (which is very heavy for lists, as their types has to be recomputed each time).

@fingolfin fingolfin added kind: discussion discussions, questions, requests for comments, and so on and removed kind: discussion discussions, questions, requests for comments, and so on kind: question labels Mar 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: discussion discussions, questions, requests for comments, and so on topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants