Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Updating modules for API reference

Open
#13 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
jupyter-notebook
Domain
documentation

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.

Description

documentation

Updating ipmag, pmag, and pmagplotlib in Pmagpy-docs repo in order to keep consistency.

Dominant language
Jupyter Notebook
Stars
5
Forks
4
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from PmagPy/PmagPy-docs

All issues in PmagPy/PmagPy-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.