search

JuliaDynamics / DynamicalSystemsBase.jl

Definition of dynamical systems and integrators for DynamicalSystems.jl
Other
53 stars 27 forks source link

One word docs change #208

Closed JonasKoziorek closed 1 month ago

JonasKoziorek commented 1 month ago

This is clearer for the reader.

Datseris commented 1 month ago

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.

JonasKoziorek commented 1 month ago

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 commented 1 month ago

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