CoupledSDEs documentation

Open
#219 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
julia
Domain
documentation

Research direction

Search the documentation for the CoupledSDEs, CoupledODEs, and PoincareMap sections and compare how they are organized. Move or incorporate the CoupledSDEs documentation to match the DynamicalSystemsBase.jl pattern, then verify that the generated documentation presents it under the same section.

Written by the indexing model from the issue text.

Description

documentation good first issue low priority

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

Dominant language
Julia
Stars
56
Forks
34
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaDynamics/DynamicalSystemsBase.jl

All issues in JuliaDynamics/DynamicalSystemsBase.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.