[FEA] Widget-style docstringa
Open
Nobody has claimed this yet.
doc
feature request
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Creating a feature request from this comment.
The request is to make docstrings of relevant methods a "widget" style, similar to what networkx does with cugraph algos, see the bottom of https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.centrality.betweenness_centrality.html
cc @dantegd
Contributor guide
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 reading the linked pull request discussion and the NetworkX betweenness-centrality documentation example. Identify which methods are considered relevant and compare their current docstrings with the requested widget style. Done means the agreed relevant methods use the documented widget-style presentation consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100