The Wayback Machine - https://web.archive.org/web/20211026011654/https://github.com/scikit-learn/scikit-learn/issues/21088
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: use :doi: and :arxiv: directives for references #21088

Open
lorentzenchr opened this issue Sep 19, 2021 · 11 comments
Open

DOC: use :doi: and :arxiv: directives for references #21088

lorentzenchr opened this issue Sep 19, 2021 · 11 comments
Labels
Documentation good first issue Sprint

Comments

@lorentzenchr
Copy link
Member

@lorentzenchr lorentzenchr commented Sep 19, 2021 •
edited by ogrisel

Describe the issue linked to the documentation

Use :doi: and :arxiv: directives for references in the documentation as is done in scipy in scipy/scipy#12858.

How to contribute Pull Requests to fix this

  • Make sure your local clone of scikit-learn of scikit-learn is up to date:
git fetch upstream main
git checkout main
git status  # check that you have no unwanted local changes pending
git merge upstream/main  # this should fast-forward
  • Looks for modules that have a reference to https://arxiv.org/... for instance using the following command:
git grep "https://arxiv.org/"

or

git grep "https://doi.org/"

or

git grep "http://citeseerx.ist.psu.edu/viewdoc/summary?doi="
  • Choose a specific source file to work on updating (check in the comments below that nobody is already working on it).
  • Do the changes (as explained below) and open a PR.
  • Choose a descriptive title for PR (e.g. "Update arxiv / doi links in module sklearn.something")
  • Link to this issue in the PR description by writing Towards #21088.

To see what can be done to update the arxiv or doi links, have a look at the diff of an already merge PR such as:

https://github.com/scikit-learn/scikit-learn/pull/21099/files
@glemaitre
Copy link
Contributor

@glemaitre glemaitre commented Sep 20, 2021

Yep we could do that as well. We could tag this as a sprint issue as well.
puhuk added a commit to puhuk/scikit-learn that referenced this issue Sep 21, 2021
@puhuk
DOC: use :doi: and :arxiv: directives for references
dea00d1 
To resolve issue scikit-learn#21088
@puhuk puhuk mentioned this issue Sep 21, 2021
Merged
@puhuk
Copy link
Contributor

@puhuk puhuk commented Sep 21, 2021

I send the PR with this issue ( #21099 ). Could you review.
@acse-srm3018
Copy link

@acse-srm3018 acse-srm3018 commented Sep 27, 2021

Can I take this issue as my first contribution to an open-source project?
@glemaitre
Copy link
Contributor

@glemaitre glemaitre commented Sep 27, 2021

@jjerphan jjerphan mentioned this issue Oct 6, 2021
Open
puhuk added a commit to puhuk/scikit-learn that referenced this issue Oct 6, 2021
@puhuk
Updates with issue scikit-learn#21088
fa7327b
puhuk added a commit to puhuk/scikit-learn that referenced this issue Oct 6, 2021
@puhuk
Resolve issue scikit-learn#21088
14794f2 
Updated based on PR review
@xyfer17
Copy link

@xyfer17 xyfer17 commented Oct 10, 2021

Is someone is woking on this issue, if no then, can I take this issue for contribution.
@puhuk
Copy link
Contributor

@puhuk puhuk commented Oct 11, 2021

Hi, I'm working on it with PR #21099
@cmarmo
Copy link
Member

@cmarmo cmarmo commented Oct 20, 2021

@reshamas this is a good issue for the sprint.
As @jjerphan said in #21099 comment there are still some links that will benefit of the new reference style.
I don't think that the files in the benchmarks directory are worth to change.
@reshamas
Copy link
Member

@reshamas reshamas commented Oct 20, 2021

@reshamas this is a good issue for the sprint. As @jjerphan said in #21099 comment there are still some links that will benefit of the new reference style. I don't think that the files in the benchmarks directory are worth to change.

Thanks @cmarmo. Will add to list.
@SultanOrazbayev
Copy link

@SultanOrazbayev SultanOrazbayev commented Oct 23, 2021

Together with @aufarkari we would like to work on this during the sprint.
@ogrisel
Copy link
Member

@ogrisel ogrisel commented Oct 23, 2021

@SultanOrazbayev @aufarkari I have edited the description to give more detailed instructions. Let me know if you need more help.
@SultanOrazbayev SultanOrazbayev mentioned this issue Oct 23, 2021
Open
1 task
aufarkari added a commit to aufarkari/scikit-learn that referenced this issue Oct 23, 2021
@aufarkari
Update the arxiv format (Towards scikit-learn#21088)
528ebfa
aufarkari added a commit to aufarkari/scikit-learn that referenced this issue Oct 23, 2021
@aufarkari
Update arxiv formatting (Towards scikit-learn#21088)
6363fe5
aufarkari added a commit to aufarkari/scikit-learn that referenced this issue Oct 23, 2021
@aufarkari
Update arxiv format (Towards scikit-learn#21088)
c1b6019
aufarkari added a commit to aufarkari/scikit-learn that referenced this issue Oct 23, 2021
@aufarkari
Update arxiv formatting (Towards scikit-learn#21088)
216314f
@ogrisel
Copy link
Member

@ogrisel ogrisel commented Oct 23, 2021

@aufarkari @SultanOrazbayev for the DOI fixes, please do individual pull requests for each file so that we can review and merge them independently of one another.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation good first issue Sprint
9 participants
@ogrisel @cmarmo @reshamas @puhuk @glemaitre @lorentzenchr @SultanOrazbayev @xyfer17 @acse-srm3018