JuliaDynamics/DynamicalSystemsBase.jl

CoupledSDEs documentation

Open

#219 opened on Oct 3, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Julia (34 forks)auto 404
documentationgood first issuelow priority

Repository metrics

Stars
 (56 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Move the CoupledSDEs documentation section to be under the DynamicalSystemsBase.jl section, consistent with CoupledODEs and PoincareMap.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85