Updating modules for API reference
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Jupyter Notebook
- Stars
- 5
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Updating ipmag, pmag, and pmagplotlib in Pmagpy-docs repo in order to keep consistency.
Contributor guide
No contributing guide indexed for this repository
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 by locating the API-reference material for ipmag, pmag, and pmagplotlib in the Pmagpy-docs repository, then compare how the three modules are documented. Update the affected reference material so the modules are consistent, and verify that the resulting API documentation is complete and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100