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

CoupledSDEs documentation #219

Open
JonasKoziorek opened this issue Oct 3, 2024 · 1 comment
Open

CoupledSDEs documentation #219

JonasKoziorek opened this issue Oct 3, 2024 · 1 comment
Labels
documentation good first issue Issue suited for a first time contributor low priority

Comments

@JonasKoziorek
Copy link
Contributor

Describe the bug
I think that the CoupledSDEs part of the documentation should be better incorporated into the rest of the docs. Other types of dynamical systems such as CoupledODEs or PoincareMap have their documentation under DynamicalSystemsBase.jl section but CoupledSDEs have their own section which break this pattern.

Example
image

@Datseris
Copy link
Member

Datseris commented Oct 3, 2024

Yeah, probably we need to rethink this a bit. At the moment the standard tutorial/documentation for how to make a typical system CoupledODEs/Map is in the main DynamicalSYstems.jl tutorial. Here only the docstrings are expanded. Because the SDE version is significantly more complex, we felt it needed a dedicated doc page. And it does.

So, ideally, one would have full proper documentation for all types of dynamical systems here. But I simply haven't had the time to contribute it (and honestly it is probably low priority; the docstrings are very good).

@Datseris Datseris added good first issue Issue suited for a first time contributor low priority labels Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Issue suited for a first time contributor low priority
Projects
None yet
Development

No branches or pull requests

2 participants