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

Misleading documentation on random number generators #508

Closed
heplesser opened this issue Oct 6, 2016 · 3 comments · Fixed by #1549
Closed

Misleading documentation on random number generators #508

heplesser opened this issue Oct 6, 2016 · 3 comments · Fixed by #1549
Assignees
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Bug Wrong statements in the code or documentation ZC: Documentation DO NOT USE THIS LABEL ZP: Pending DO NOT USE THIS LABEL
Milestone

Comments

@heplesser
Copy link
Contributor

On http://www.nest-simulator.org/random_numbers/, most relevant information in seeding RNGs is given under the "random numbers in parallel simulations" heading. This is misleading, since users need to seed the grng and the thread-0 rng in serial simulations.

@heplesser heplesser added ZC: Documentation DO NOT USE THIS LABEL I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) ZP: Pending DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Bug Wrong statements in the code or documentation labels Nov 17, 2016
@heplesser heplesser self-assigned this Apr 4, 2017
@mschmidt87
Copy link

Actually, I was just looking something up in the documentation on random numbers and realized that it is outdated. It still uses the old function names for creation of connections, such as RandomDivergentConnect, so this should be updated as well.

@terhorstd
Copy link
Contributor

@heplesser, could you give some updates on the status of this?

@heplesser
Copy link
Contributor Author

Fixing the documentation guide on random numbers as part of #1549 is very high on my agenda, hope to get to it later this week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Bug Wrong statements in the code or documentation ZC: Documentation DO NOT USE THIS LABEL ZP: Pending DO NOT USE THIS LABEL
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants