NatLabRockies / NatLabRockies/REopt_API
Improve documentation of multiple outages model (API)
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 125
- Forks
- 68
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
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 by reading the referenced REopt.jl issue 286 and locating the REopt API documentation for the multiple outages model. Confirm which API behavior needs explanation and update the relevant documentation so the model's usage and expected results are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100