[mkdocs] return type format in plotly.figure_factory functions
Open
Nobody has claimed this yet.
documentation
P2
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Description
- After converting the docstrings of each function into numpy style, the return types are not as clear and might want to be edited for clarity. For example, the following return type for
create_facet_grid:
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
Review the NumPy-style docstrings for the plotly.figure_factory functions, starting with the create_facet_grid return-type example in the issue. Clarify the return types consistently across the affected functions, with completion indicated by clear documentation for each return value.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100