leanprover-community / leanprover-community/physlib
Improvement of module documentation
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 749
- Forks
- 189
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 75
Description
The following modules need their module doc-string improved (this is the first docstring in the file) to include the following information:
- A description of the physical content of the module (file) (or if it is the
Basicmodule an overall physical description of the physics within that directory). - The current status, i.e. what are the important definitions and lemmas in that file or directory.
- What is left to be done, with referenced TODO items.
An example is given in
If you update one of these please change the status of it here, or write a comment on this issue. More modules may be added to this list.
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
Use the example in PhysLean/ClassicalMechanics/HarmonicOscillator/Basic.lean as the reference, then inspect the module docstrings in PhysLean/Electromagnetism/Basic.lean, PhysLean/Particles/StandardModel/Basic.lean, and PhysLean/Electromagnetism/MaxwellEquations.lean. Done means each first docstring describes the physical content, current definitions and lemmas, remaining work, and referenced TODO items; update the checklist or comment on the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100