invenia / invenia/Checkpoints.jl
Add examples of using indexing functionality to Readme and docs
Open
documentation
- Dominant language
- Julia
- Stars
- 12
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Probably should have been done as part of #22
but I didn't think to, it just has API docs.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the current API documentation and the work referenced in issue #22, then inspect the README and documentation locations for indexing coverage. Add practical indexing examples in both places, with wording consistent with the existing API docs, and verify that the examples render correctly.
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
- 38/100