-
Notifications
You must be signed in to change notification settings - Fork 9
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
New Doc Style Guide #85
Conversation
159fd79
to
21fe385
Compare
I'm investigating how "pydocstyle" and "numpydoc_validation_checks" fit together. It does not have the sense to have two cheks that aim for the same goal. However, I am not sure about the capabilities and robustness of each one. |
Of course, they are compatible. The Nevertheless, I made some tests locally for checking the robustness of |
Alright, if |
Unless some |
Hahaha, it looks like @akaszynski already faced this issue, opened numpy/numpydoc#364, and devised numpydoc-validation. |
Opening pyvista/numpydoc-validation#2. |
I'm reviewing this in deep, especially the configuration for the various cited tools. I want to make sure they are not in conflict or that we are imposing double conditions at the same time. |
542f989
to
8532376
Compare
4e3f703
to
5d1661b
Compare
Once PyCQA/docformatter#77 gets merged and a new release is published, it will be possible to update |
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
d317c97
to
b72c5e0
Compare
2e0da11
to
0fcdecf
Compare
0732c00
to
9fc4508
Compare
This is ready for review, @PipKat @MaxJPRey and @Revathyvenugopal162. I moved the "Class Documentation" section to the "Guidelines and Best Practices". This chapter is expected to be renamed "How-To" in an incoming PR. |
Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
@jorgepiloto Excellent work. Thanks! |
faf00ac
to
1756c33
Compare
GitHub didn't allowed me to apply suggested changes in "batch mode", not sure why... I manually applied those. |
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Partially solves for #64.