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.

Sign up for GitHub

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

Ensure that docstrings pass numpydoc validation #20308

Closed
thomasjpfan opened this issue Jun 21, 2021 · 212 comments · Fixed by #21468
Closed

Ensure that docstrings pass numpydoc validation #20308

thomasjpfan opened this issue Jun 21, 2021 · 212 comments · Fixed by #21468
Labels
Documentation good first issue Easy with clear instructions to resolve Sprint

Comments

@thomasjpfan
Copy link
Member

thomasjpfan commented Jun 21, 2021 •
edited by jeremiedbb
Loading

  1. Make sure you have the development dependencies and documentation dependencies installed.
  2. Pick an estimator from the list below and leave a comment saying you are going to work on it. This way we can keep track of what everyone is working on.
  3. Remove the estimator from the list at:

    scikit-learn/maint_tools/test_docstrings.py

    Line 11 in bb6117b

    DOCSTRING_IGNORE_LIST = [
  4. Let's say you picked StandardScaler, run numpydoc validation as follows (Adding the - at the end helps with the regex).
pytest maint_tools/test_docstrings.py -k StandardScaler-
  1. If you see failing test, please fix them by following the recommendation provided by the failing test.
  2. If you see all the tests past, you do not need to do any additional changes.
  3. Commit your changes.
  4. Open a Pull Request with an opening message Addresses #20308. Note that each item should be submitted in a separate Pull Request.
  5. Include the estimator name in the title of the pull request. For example: "DOC Ensures that StandardScaler passes numpydoc validation".
@j3nnn1
Copy link
Contributor

j3nnn1 commented Jun 26, 2021 •
edited
Loading

Can I take the estimator: ¨AdaBoostClassifier¨? partner cc: @genvalen

@alinealfa
Copy link
Contributor

@marenwestermann and I are working on RandomForestClassifier

@NicolasMillerr
Copy link
Contributor

NicolasMillerr commented Jun 26, 2021 •
edited
Loading

@MattNP and I are starting off with the StandardScaler

@gloriamacia
Copy link
Contributor

@caherrera-meli and I are going for the LinearRegression

@lacouth
Copy link
Contributor

lacouth commented Jun 26, 2021

@gitdoluquita and I are going for the LogisticRegression

@ludigoncalves
Copy link

I'm going with ExtraTreeClassifier!

@pibieta
Copy link
Contributor

pibieta commented Jun 26, 2021

@g4brielvs and I are working on KNeighborsClassifier

@Anavelyz
Copy link
Contributor

@marielaraj and me are going for PCA

@LucyJimenez
Copy link
Contributor

LucyJimenez commented Jun 26, 2021 •
edited
Loading

@eugeniaft and me are going for DecisionTreeClassifier.

@trhughes
Copy link

@napoles-uach and I are working on KNeighborsRegressor

@g4brielvs
Copy link
Contributor

g4brielvs commented Jun 26, 2021 •
edited
Loading

@g4brielvs and @pibieta are working on KMeans

@sebastiandres
Copy link
Contributor

sebastiandres commented Jun 26, 2021 •
edited
Loading

With @leonardorocc0 will be taking ARDRegression

@jmloyola
Copy link
Member

With @tomasmoreyra will be taking TfidfTransformer

@jbsilva
Copy link
Contributor

jbsilva commented Jun 26, 2021

I'm working on BaggingClassifier.

@asnramos
Copy link

asnramos commented Jun 26, 2021 •
edited
Loading

BayesianGaussianMixture Estamos trabajando con @nicolas471

@fbidu
Copy link
Contributor

fbidu commented Jun 26, 2021

I'm working on DBSCAN with @ijpulidos

@NicolasMillerr NicolasMillerr mentioned this issue Jun 26, 2021
Merged
@GabrielBernardoMC
Copy link

GabrielBernardoMC commented Jun 26, 2021 •
edited
Loading

me and @joaovitormascarenhas are going for CountVectorizer

@MattNP
Copy link
Contributor

MattNP commented Jun 26, 2021

Me and @NicolasMillerr will be working on GaussianProcessClassifier

lacouth added a commit to lacouth/scikit-learn that referenced this issue Jun 26, 2021
@lacouth
Adresses scikit-learn#20308 LogisticRegression
c115936
@gloriamacia gloriamacia mentioned this issue Jun 26, 2021
Merged
@lacouth lacouth mentioned this issue Jun 26, 2021
Merged
@gitdoluquita
Copy link
Contributor

@lacouth and I are going for the LogisticRegressionCV

@caherrera-meli
Copy link
Contributor

@gloriamacia and I will continue with DummyRegressor

@pibieta pibieta mentioned this issue Jun 26, 2021
Merged
@j3nnn1 j3nnn1 mentioned this issue Jun 26, 2021
Merged
gitdoluquita added a commit to gitdoluquita/scikit-learn that referenced this issue Jun 26, 2021
@gitdoluquita
Adresses scikit-learn#20308 LogisticRegressionCV
01f3944
@fbidu fbidu mentioned this issue Jun 26, 2021
Merged
@g4brielvs g4brielvs mentioned this issue Oct 16, 2021
Merged
@g4brielvs
Copy link
Contributor

Working LabelPropagation

@g4brielvs g4brielvs mentioned this issue Oct 16, 2021
Closed
@felixglush
Copy link
Contributor

Working on MultiTaskLasso

@felixglush felixglush mentioned this issue Oct 18, 2021
Merged
@spikebh
Copy link
Contributor

spikebh commented Oct 21, 2021 •
edited
Loading

I'm working on MultiTaskElasticNet

@spikebh spikebh mentioned this issue Oct 21, 2021
Merged
@spikebh
Copy link
Contributor

spikebh commented Oct 21, 2021

Now i'm working on MultiTaskElasticNetCV

@spikebh spikebh mentioned this issue Oct 21, 2021
Closed
@g4brielvs
Copy link
Contributor

Working on SpectralBiclustering

@g4brielvs g4brielvs mentioned this issue Oct 21, 2021
Merged
@g4brielvs
Copy link
Contributor

Working on SpectralEmbedding

@ogrisel ogrisel mentioned this issue Oct 22, 2021
Closed
@spikebh spikebh mentioned this issue Oct 22, 2021
Merged
@spikebh
Copy link
Contributor

spikebh commented Oct 22, 2021

Working on OrthogonalMatchingPursuitCV

@g4brielvs g4brielvs mentioned this issue Oct 22, 2021
Merged
3 tasks
@spikebh spikebh mentioned this issue Oct 22, 2021
Merged
1 task
@g4brielvs
Copy link
Contributor

g4brielvs commented Oct 22, 2021 •
edited
Loading

Working on PassiveAggressiveRegressor and LabelSpreading. I believe these would be the last on the list!

This was referenced Oct 22, 2021
Merged
Merged
@baam25simo
Copy link
Contributor

Working on StackingRegressor

@baam25simo baam25simo mentioned this issue Oct 24, 2021
Merged
@Icyshaman
Copy link
Contributor

Working on SpectralCoclustering

@Icyshaman Icyshaman mentioned this issue Oct 26, 2021
Merged
@ogrisel
Copy link
Member

ogrisel commented Oct 26, 2021

This is done! Thanks @Icyshaman for the last PR.

I think we could do another PR to simplify the test and remove the empty ignore list before closing this issue.

@Icyshaman
Copy link
Contributor

This is done! Thanks @Icyshaman for the last PR.

I think we could do another PR to simplify the test and remove the empty ignore list before closing this issue.

Working on it

This was referenced Oct 26, 2021
Closed
Merged
@jeremiedbb jeremiedbb mentioned this issue Mar 21, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation good first issue Easy with clear instructions to resolve Sprint
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

TST Simplify the test and remove empty DOCSTRING_IGNORE_LIST Icyshaman/scikit-learn