litestar-org / litestar-org/polyfactory
Docs: Document functions/classes/methods that have no docstrings and are missing from the built docs
Open
documentation
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 120
- PR merge metrics
- No merged PRs in 30d
Description
We should document these. I don't think any are exposed in the reference documentation because of lack of docstrings
_Originally posted by @JacobCoffee in https://github.com/litestar-org/polyfactory/pull/530#discussion_r1585191572_
Contributor guide
Research direction
Start by reviewing the reference documentation and the project’s Python functions, classes, and methods to find public items without docstrings. Check how the built docs expose documented items, then add documentation for the missing items and rebuild the reference docs to confirm they appear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100