Skip to content

Commit 6d96ddf

Browse files
committed
Add documentation requirements section to CLAUDE.md
Ensures consistency for future development by specifying what documentation updates are required when implementing new functionality: - README.md: features list, usage examples, API reference - docs/api/*.rst: RST documentation with autoclass directives - docs/tutorials/*.ipynb: working examples in relevant tutorials - CLAUDE.md: module and test structure updates - ROADMAP.md: version and status updates - Scholarly references format for academic methods
1 parent 186db7d commit 6d96ddf

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,3 +156,55 @@ Tests mirror the source modules:
156156
### Dependencies
157157

158158
Core dependencies are numpy, pandas, and scipy only (no statsmodels). The library implements its own OLS, robust standard errors, and inference.
159+
160+
## Documentation Requirements
161+
162+
When implementing new functionality, **always include accompanying documentation updates**:
163+
164+
### For New Estimators or Major Features
165+
166+
1. **README.md** - Add:
167+
- Feature mention in the features list
168+
- Full usage section with code examples
169+
- Parameter documentation table
170+
- API reference section (constructor params, fit() params, results attributes/methods)
171+
- Scholarly references if applicable
172+
173+
2. **docs/api/*.rst** - Add:
174+
- RST documentation with `autoclass` directives
175+
- Method summaries
176+
- References to academic papers
177+
178+
3. **docs/tutorials/*.ipynb** - Update relevant tutorial or create new one:
179+
- Working code examples
180+
- Explanation of when/why to use the feature
181+
- Comparison with related functionality
182+
183+
4. **CLAUDE.md** - Update:
184+
- Module structure section
185+
- Test structure section
186+
- Any relevant design patterns
187+
188+
5. **ROADMAP.md** - Update:
189+
- Move implemented features from planned to current status
190+
- Update version numbers
191+
192+
### For Bug Fixes or Minor Enhancements
193+
194+
- Update relevant docstrings
195+
- Add/update tests
196+
- Update CHANGELOG.md (if exists)
197+
198+
### Scholarly References
199+
200+
For methods based on academic papers, always include:
201+
- Full citation in README.md references section
202+
- Reference in RST docs with paper details
203+
- Citation in tutorial summary
204+
205+
Example format:
206+
```
207+
Sun, L., & Abraham, S. (2021). Estimating dynamic treatment effects in
208+
event studies with heterogeneous treatment effects. *Journal of Econometrics*,
209+
225(2), 175-199.
210+
```

0 commit comments

Comments
 (0)