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

Graph.discrete_demographic_events() should document pulse ordering. #329

Open
grahamgower opened this issue Jun 13, 2021 · 0 comments
Open
Labels
docs Improvements or additions to documentation

Comments

@grahamgower
Copy link
Member

Current behaviour of Graph.discrete_demographic_events() is to return the pulses list as is. This means the pulse order is maintained. This ordering is important when multiple pulses have the same time value, and we should document that the pulse order is maintained.

Compared to the other discrete events, the pulses list is not constructed on the fly, so we should also document that the Graph.pulses list is returned verbatim and shouldn't be modified. (Or maybe we should copy the list before returning it instead?)

@grahamgower grahamgower added the docs Improvements or additions to documentation label Jun 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant