[DOC] Looking into automating boilerplate in pydocs
Open
Nobody has claimed this yet.
doc
- Dominant language
- Cuda
- Stars
- 1k
- Forks
- 251
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 31
Description
As we continue to beef up and build out pylibraft, @dantegd pointed out that there's some boilerplate stuff in the pydocs that we could start centralizing and consolidating to make it easier to manage (and remove the duplication). An approach like what's being done in cuml current could be useful here.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the pylibraft pydocs and comparing their repeated boilerplate with the approach currently used in cuML. Identify which documentation pieces can be centralized or consolidated, then confirm that duplication is reduced and the generated pydocs remain complete.
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