docs(qft): add Feynman diagram and topological field theory API maps - #1492
docs(qft): add Feynman diagram and topological field theory API maps#1492Robby955 wants to merge 1 commit into
Conversation
|
Thank you for this pull-request (PR). If this is your first PR, welcome to the community! Below is what will happen next. Please read carefully if you are not familiar with the process. You may open other PRs while this one is being reviewed, and can stack PRs on top of each other, so don't let these steps slow you down.
Tip: The easiest way to get have a fast review is to submit a PR that is small and self-contained, and has clear documentation explaining why things are the way they are in your chages. If you have any problems or questions, please reach out to the community on the Zulip. |
Motivation
Related to #1414, the tracking maps for the Feynman diagram API in #882 and the topological field theory API in #877. Following the discussion in #1414, an API with no implementation yet still gets a map in the file system with every requirement marked not done; these are two of those.
Changes
Adds
Physlib/QFT/PerturbationTheory/FeynmanDiagrams/API-map.yamlandPhyslib/QFT/TopologicalFieldTheory/API-map.yaml. Every requirement in both is recorded as not done with locationN/A, 6 in the first and 17 in the second, so each map is specification only. The Feynman diagram directory holdsBasic.lean, which states the intended design in its module documentation and declares nothing, so the map writes that design out as requirements and names the perturbation-theory APIs a diagram type would sit on.Physlib/QFT/TopologicalFieldTheoryhas no Lean file at all and now contains only the map;check_file_importswalks.leanfiles alone, so the import check is unaffected. Nothing outside the two new files changes, and no Lean source is touched.FeynmanDiagrams/Basic.leanasks that you be contacted before anyone works in that directory. I have added only the map there and changed no Lean file, but say the word and I will drop that half and keep the topological field theory map alone.Checks
python3 scripts/api_map_linter.py --repo .passes with no missing files and no missing names. Both new maps report zero checked entries, since no requirement claims a location.