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

Testing docstring integrity #3309

Open
jni opened this issue Aug 2, 2018 · 1 comment
Open

Testing docstring integrity #3309

jni opened this issue Aug 2, 2018 · 1 comment
Labels
📄 type: Documentation Updates, fixes and additions to documentation 🤖 type: Infrastructure CI, packaging, tools and automation

Comments

@jni
Copy link
Member

jni commented Aug 2, 2018

Description

I just came across this on Twitter: scikit-learn test docstrings for compliance with the NumPyDoc standard and matching to the actual function signature.

https://github.com/NicolasHug/scikit-learn/blob/27625cfa573c9f7208da596966ed769030d5f5bd/sklearn/tests/test_docstring_parameters.py

Seems like a useful thing to have.
@sciunto sciunto added the 🤖 type: Infrastructure CI, packaging, tools and automation label Feb 1, 2019
@sciunto sciunto added this to the 1.0 milestone Feb 1, 2019
@scikit-image scikit-image locked and limited conversation to collaborators Oct 18, 2021
@grlee77 grlee77 mentioned this issue Feb 20, 2022
Closed
@scikit-image scikit-image unlocked this conversation Mar 27, 2022
@grlee77 grlee77 reopened this Mar 27, 2022
@grlee77
Copy link
Contributor

grlee77 commented Mar 27, 2022 •
edited

On a related note, we did have PRs autoformatting docstrings for a few modules in #4845, #4849 and #5317. I think these used velin for that purpose.

@grlee77 grlee77 added the 📄 type: Documentation Updates, fixes and additions to documentation label Mar 27, 2022
@jarrodmillman jarrodmillman modified the milestones: 0.21, 0.22 May 19, 2023
@jarrodmillman jarrodmillman modified the milestones: 0.22, 0.23 Oct 24, 2023
@jarrodmillman jarrodmillman removed this from the 0.23 milestone Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📄 type: Documentation Updates, fixes and additions to documentation 🤖 type: Infrastructure CI, packaging, tools and automation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@jarrodmillman @sciunto @jni @rfezzani @grlee77