Docstrings for Braginskii ClassicalTransport
Open
Nobody has claimed this yet.
transport
- Dominant language
- Python
- Stars
- 711
- Forks
- 375
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 8
Description
The Braginskii methods in classical_transport currently in transport (this will move with #303) have minimal docstrings. It would be quite helpful to add:
- information on units
- some physical discussion
- where do all these equations come from (references)
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 Braginskii methods in plasmapy/transport.py under classical_transport, while checking issue #303 for the planned move. Review each method's existing docstring and identify the units, physical explanation, and source references that are missing. Done means the methods document all three areas clearly in their new or current location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100