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.

Sign up for GitHub

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

Jump to bottom

One word docs change #208

Merged
merged 1 commit into from
Jun 17, 2024
Merged

One word docs change #208

merged 1 commit into from
Jun 17, 2024

Conversation

JonasKoziorek
Copy link
Contributor

This is clearer for the reader.

@Datseris
Copy link
Member

It should stay DynamicalSystem, as this is what contains the API reference. The user can understand if this is a discrete time or not from the rest of the docstring.

@Datseris Datseris closed this Jun 17, 2024
@JonasKoziorek
Copy link
Contributor Author

For remaining systems it's clear from the docstring as well but the first supertype is specified:

CoupledODEs <: ContinuousTimeDynamicalSystem
StroboscopicMap <: DiscreteTimeDynamicalSystem
PoincareMap <: DiscreteTimeDynamicalSystem

etc.

@Datseris Datseris reopened this Jun 17, 2024
@Datseris Datseris merged commit 8735b71 into JuliaDynamics:main Jun 17, 2024
2 of 5 checks passed
@Datseris
Copy link
Member

ah, unfortunate that we have done it like this for the other systems...

@JonasKoziorek JonasKoziorek deleted the minor_doc_fix branch July 21, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@JonasKoziorek @Datseris