Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Updating modules for API reference

未关闭
#13 12 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
技术栈
jupyter-notebook
领域
documentation

调研方向

首先在 Pmagpy-docs 仓库中找到 ipmag、pmag 和 pmagplotlib 的 API 参考资料,然后比较这三个模块的文档编写方式。更新受影响的参考资料,使这些模块保持一致,并验证生成的 API 文档完整且一致。

由索引模型根据 Issue 内容生成。

描述

documentation

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

主要语言
Jupyter Notebook
星标
5
派生
4
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

PmagPy/PmagPy-docs 的其他 Issue

查看 PmagPy/PmagPy-docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。