Sienna-Platform / Sienna-Platform/PowerOperationsModels.jl
Recover lost docstrings
Open
Nobody has claimed this yet.
PSI parity
- Dominant language
- Julia
- Stars
- 2
- Forks
- 1
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 26
Description
As I'm moving things between IOM and POM (with the help of Claude code), docstrings often aren't preserved. We'll have to go back and fix that at some point, but low priority for now. Should be pretty easy to do with AI.
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 comparing the code moved between IOM and POM and identify definitions whose docstrings were not preserved. Restore the missing documentation across the affected code, with completion marked by the moved definitions having their intended docstrings again.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100