Skip to content

docs: document model estimator methods - #44

Merged
shivamlalakiya merged 3 commits into
PhilanthroPy-Project:mainfrom
slegarraga:docs/model-method-docstrings
Aug 7, 2026
Merged

docs: document model estimator methods#44
shivamlalakiya merged 3 commits into
PhilanthroPy-Project:mainfrom
slegarraga:docs/model-method-docstrings

Conversation

@slegarraga

Copy link
Copy Markdown
Contributor

Closes #32.

Adds NumPy-style docstrings to fit, predict, and predict_proba on:

  • MajorGiftClassifier (plus predict_affinity_score)
  • MovesManagementClassifier
  • PlannedGivingIntentScorer
  • PropensityScorer

Verified:

  • missing-docstring check prints MISSING: none then OK
  • doctests: 28 passed
  • model tests: 58 passed

@slegarraga
slegarraga force-pushed the docs/model-method-docstrings branch from 9a3c8a5 to 7ba412a Compare August 6, 2026 22:50
@shivamlalakiya
shivamlalakiya merged commit 83cb94a into PhilanthroPy-Project:main Aug 7, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fit/predict/predict_proba on the four philanthropy.models estimators have no docstrings (13 methods render blank)

2 participants