-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Fix SA04 errors in docstrings #28792
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
Comments
Hi, anyone working on this? |
Not right now. Just posted yesterday, so go for it! |
@Nabel0721 what fix can you recommend? |
If you find any in shared docs, that’ll fix the issue in multiple places. (For instance, I think Series.pipe and DataFrame.pipe come from the same shared_doc value). Other than that, just go for whatever you’d like! These don’t need to be done all at once. |
Hi @Nabel0721, may I work on this issue. I was able to locate some of these issues in the code documentation. I'm a newbie to contributing to open source, I'll try my best. |
For sure. I opened the issue, but that doesn't mean I'm in charge of it. If you want to work on something go ahead! |
pandas-dev Issue pandas-dev#28792
pandas-dev Issue pandas-dev#28792
pandas-dev issue pandas-dev#28792
pandas-dev Issue pandas-dev#28792
pandas-dev Issue pandas-dev#28792
pandas-dev Issue pandas-dev#28792
pandas-dev Issue pandas-dev#28792
is there still work to be done on this issue ? I'm new and would like to help if there is. |
|
Thank you. This is my first contribution so I'm working through it piece by piece. I just pushed my very first commit on PR06 documentation errors and it failed in the "web and docs" build. Do you happen to know why? I'm assuming that's an issue I need to resolve ? Thanks... |
Is this ticket still open and need some help? |
see #28792 (comment) |
take |
@simonjayhawkins Created #37219 partial fix please review. |
@simonjayhawkins Completed this task. |
* DOC: Updated resample.py and groupby.py to fix SA04 Errors * DOC: Fixed flake8 issue * #28792 DOC: Fixed SA04 Errors * #28792 Doc Fix SA04 Errors * Update pandas/core/arrays/integer.py Co-authored-by: Joris Van den Bossche <[email protected]> * Update pandas/core/arrays/boolean.py Co-authored-by: Joris Van den Bossche <[email protected]> * #28792 DOC: udpated reviewers comments * #28792 DOC: Fixing flake8 Errors Co-authored-by: Nagesh Kumar C <[email protected]> Co-authored-by: Joris Van den Bossche <[email protected]> Co-authored-by: Simon Hawkins <[email protected]>
…v#37219) * DOC: Updated resample.py and groupby.py to fix SA04 Errors * DOC: Fixed flake8 issue * pandas-dev#28792 DOC: Fixed SA04 Errors * pandas-dev#28792 Doc Fix SA04 Errors * Update pandas/core/arrays/integer.py Co-authored-by: Joris Van den Bossche <[email protected]> * Update pandas/core/arrays/boolean.py Co-authored-by: Joris Van den Bossche <[email protected]> * pandas-dev#28792 DOC: udpated reviewers comments * pandas-dev#28792 DOC: Fixing flake8 Errors Co-authored-by: Nagesh Kumar C <[email protected]> Co-authored-by: Joris Van den Bossche <[email protected]> Co-authored-by: Simon Hawkins <[email protected]>
…v#37219) * DOC: Updated resample.py and groupby.py to fix SA04 Errors * DOC: Fixed flake8 issue * pandas-dev#28792 DOC: Fixed SA04 Errors * pandas-dev#28792 Doc Fix SA04 Errors * Update pandas/core/arrays/integer.py Co-authored-by: Joris Van den Bossche <[email protected]> * Update pandas/core/arrays/boolean.py Co-authored-by: Joris Van den Bossche <[email protected]> * pandas-dev#28792 DOC: udpated reviewers comments * pandas-dev#28792 DOC: Fixing flake8 Errors Co-authored-by: Nagesh Kumar C <[email protected]> Co-authored-by: Joris Van den Bossche <[email protected]> Co-authored-by: Simon Hawkins <[email protected]>
@suparnasnair Can you please tell me that in "pandas.DataFrame.empty" and "pandas.Series.subtract" what are DataFrame, Series are? Are these the folder name or Python file name? Because I am not able to see any folder with such name. |
Closing as a duplicate of #28792 |
There are issues in some docstrings where the See Also section is not complete. All of the following errors exist because there is no description for a referenced function or method. If these can get fixed then CI will be able to check all of the See Also section errors! The command to check for the errors is
./scripts/validate_docstrings.py --errors=SA04
The text was updated successfully, but these errors were encountered: