lmcinnes / lmcinnes/umap

Citation information outdated in documentation

Open
#683 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.3k
Forks
871
Avg merge
1d 13h
Merged PRs (30d)
5

Description

I saw here https://umap-learn.readthedocs.io/en/latest/parametric_umap.html#citing-our-work that the link is still pending, however, the README https://github.com/lmcinnes/umap#citation contains such information.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the citation section of the Read the Docs page at parametric_umap.html#citing-our-work with the README's citation section. Update the documentation so it contains the citation information already present in the README, then verify the rendered page no longer says the link is pending.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.