leanprover-community / leanprover-community/physlib

Module doc-string improvements

Open
#713 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lean
Stars
749
Forks
189
Avg merge
1d 21h
Merged PRs (30d)
75

Description

This issue is to track which module-doc strings are good and which need improving.

If a doc-string for a module is already 'good', please tick it off here, otherwise feel free to improve it.

Doc-string module improvements

Classical mechanics
Condensed matter
Cosmology
Electromagnetism
Mathematics
Meta
Optics
Particles
QFT
Quantum mechanics
Relativity
SpaceAndTime
StatisticalMechanics
StringTheory
Thermodynamics
Units

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Choose one unchecked module from the checklist, such as PhysLean.ClassicalMechanics.Basic or PhysLean.Meta.Basic, and read its existing module doc-string in the linked .lean file. Improve the documentation where needed, confirm it accurately describes the module, and tick that entry when complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.