SciML / SciML/JumpProcesses.jl
Documentation: wording of the definition of a jump process
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 150
- Forks
- 41
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 28
Description
The mathematical overview in the documentation at
https://github.com/SciML/JumpProcesses.jl/blame/9e272f797d1dfd23f79cc61a737d2a296e5f699d/docs/src/index.md#L52-L53C33 essentially reads that the random process dN(.) attains at a particular time t a value 1 with some probability. Am I interpreting it correctly? I would argue that this might misleading since such probability is always zero for a process defined over a continuous time, isn't it? Perhaps some rewording could help. I am not fluent with the stochastic process lingo, though.
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
Start with docs/src/index.md around lines 52–53 and read the surrounding mathematical overview. Check the wording against the intended definition of a continuous-time jump process, then revise it so the probability statement is mathematically unambiguous; done means the documentation accurately describes the process without implying a positive probability for an event at one exact time.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100