docs: `read_gifts` docstring names 5 of the 7 `GIFT_SOURCES`, and two registry comments point at CLI code that is going away

已关闭 适合新手
  • 哪里不对？
#360 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

已经有一个关联 PR 被合并了。

  • #373 来自 @shivamlalakiya —— 已合并

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
python
领域
documentation

调研方向

阅读philanthropy/ingest/_read_gifts.py，尤其是第40到80行，并更新read_gifts的docstring以及GIFT_SOURCES和_REGISTRY上方的注释。在changelog的[Unreleased]和### Documentation下添加一条项目。运行指定的doctest命令和make ci；两者都通过，并且描述不再依赖CLI细节或重复源名称，即表示完成。

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

描述

beginner documentation good first issue roadmap
Goal

The read_gifts docstring and the comments next to GIFT_SOURCES and _REGISTRY describe the registry as it is, so a reader of help(read_gifts) sees every CRM it accepts.

What is wrong today

In philanthropy/ingest/_read_gifts.py:

  • The read_gifts docstring says the registry maps "each of civicrm, raisers_edge, npsp, nonprofit_cloud, and blackbaud_crm". That is 5 of the 7 names in GIFT_SOURCES: bloomerang and donorperfect are missing.
  • The comment above GIFT_SOURCES says the names are listed "in the order the CLI's --source choices already list them". The CLI lists only four (_FEATURE_SOURCES in philanthropy/cli.py), and once #338 lands it reads GIFT_SOURCES directly, so the sentence is backwards either way.
  • The comment above _REGISTRY says it has "the same shape as the preset dispatch in cli.py's _cmd_features". #338 removes that dispatch.
Acceptance criteria
  • The docstring points at GIFT_SOURCES instead of naming sources, so the next reader cannot make it stale again (the same rule #339 applies to the README row).
  • The two comments say what the objects are without referring to the CLI.
  • python -m pytest --doctest-modules philanthropy/ingest/_read_gifts.py and make ci pass.
  • One CHANGELOG bullet under [Unreleased], ### Documentation.
Scope

Docstring and comments in one file. No behaviour change.

Where to start
  • philanthropy/ingest/_read_gifts.py, lines 40 to 80
Dependencies
  • None. If #338's PR (#354) is still open, rebase after it merges; the comment edits touch nearby lines only.

Comment on this issue before you start so two people don't build the same thing.

主要语言
Python
星标
11
派生
23
平均合并
1 天 6 小时
30 天内合并 PR
34

环境准备

从这里开始

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

PhilanthroPy-Project/PhilanthroPy 的其他 Issue

查看 PhilanthroPy-Project/PhilanthroPy 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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