JuliaGaussianProcesses / JuliaGaussianProcesses/AbstractGPs.jl
Test code examples in documentation
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 287
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
There are some example code snippets in the docs (particularly docs/src/concrete_features.md) which aren't run as doctests.
As noted here, some of these examples didn't even run, so it's probably worth converting them to doctests of some kind (perhaps hiding the output?).
Contributor guide
No contributing guide indexed for this repository
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 the examples in docs/src/concrete_features.md and review the related discussion in pull request 194. Identify snippets that are not currently exercised, convert them to doctests with suitable output handling, and confirm that the documented examples run successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100