Couple of bugs/typos in the current documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 8.3k
- Forks
- 871
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 5
Description
Hey,
Looking at the documentation quickly, I noticed a couple of things:
- Emphasis and hyperlinks don't work well together (unless it's intended)
- None of the examples are run
- Useful functions in the API guide include UMAP class, whose documentation is available just above that and it's a class
Best regards,
Johann
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 with the linked how_umap_works.html and auto_examples/index.html documentation pages. Check the emphasis and hyperlink rendering, whether the examples are executed, and the API guide wording around the UMAP class. Done means these documentation issues are corrected and the affected pages render with accurate, working examples.
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
- 35/100