leanprover-community / leanprover-community/physlib
PhysLean.ClassicalMechanics.HarmonicOscillator.Basic
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 749
- Forks
- 189
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 75
Description
This issue is for the improvement of the documentation related to the Harmonic Oscillator.
We should check the following:
- Are there any typos or grammatical errors?
- Does the structure make sense to someone with a limited understanding of Lean? (if not what can be improved)
The documentation currently is attached:
If you have suggestions of improvements feel free to add a comment below, and I can edit the docs accordingly whilst making the suggester a co-author of the commit.
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 the attached HarmonicOscillator_basic.pdf and review the documentation for PhysLean.ClassicalMechanics.HarmonicOscillator.Basic. Check for typos and grammatical errors, then assess whether its structure is understandable to readers with limited Lean knowledge. Done means documenting concrete improvement suggestions or edits that address these checks.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100