Add and apply glossary term for OML
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 711
- Forks
- 375
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 8
Description
OML is short for "orbital-motion-limited" theory. It's used in the context of Langmuir probes in PlasmaPy, and I've also noticed it in textbooks on dusty plasma physics. (I'm not certain if it means the same exact thing in dusty plasmas and in plasma diagnostics, though.)
Given that we use "OML" in a few different places, it would be helpful to create a glossary entry in docs/glossary.rst that describes what it is, and then use :term:`OML` when it gets used in the documentation and docstrings.
This would be a good first contribution for a plasma physicist who has a good understanding of OML theory.
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 docs/glossary.rst, then search the documentation and docstrings for uses of OML and compare nearby glossary-linking conventions. Add an accurate glossary entry that accounts for the stated plasma contexts and replace relevant uses with :term:OML; done means the glossary entry and all applicable references are updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100