SciML / SciML/DiffEqNoiseProcess.jl
mutable struct in docstrings
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 62
- Forks
- 32
- Avg merge
- 8h 38m
- Merged PRs (30d)
- 16
Description
I'm trying to format the docstrings to SciML style.
The "mutable struct" here messes up the formatter.
https://docs.sciml.ai/DiffEqNoiseProcess/stable/abstract_noise_processes/#DiffEqNoiseProcess.NoiseProcess
Remove it like https://docs.sciml.ai/DiffEqDocs/stable/types/ode_types/#SciMLBase.ODEFunction ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the NoiseProcess docstring and its generated documentation at the linked DiffEqNoiseProcess page, then compare it with the SciMLBase.ODEFunction documentation example. Confirm what formatter output is currently affected and remove the mutable struct text if appropriate; done means the docstring formats like the referenced example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100