Skip to content

DOC: fix EX03 errors in docstrings - pandas.errors: SettingWithCopyWarning, SpecificationError, UndefinedVariableError #56989

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
Merged
merged 1 commit into from
Jan 21, 2024
Merged

DOC: fix EX03 errors in docstrings - pandas.errors: SettingWithCopyWarning, SpecificationError, UndefinedVariableError #56989

merged 1 commit into from
Jan 21, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

All EX03 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.SettingWithCopyWarning
  2. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.SpecificationError
  3. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.UndefinedVariableError

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.SettingWithCopyWarning
################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.errors.SettingWithCopyWarning`:
	SA01	See Also section not found
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.SpecificationError
################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.errors.SpecificationError`:
	SA01	See Also section not found
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.errors.UndefinedVariableError
################################################################################
################################## Validation ##################################
################################################################################

2 Errors found for `pandas.errors.UndefinedVariableError`:
	PR01	Parameters {'name', 'is_local'} not documented
	SA01	See Also section not found

@jordan-d-murphy
DOC: fix EX03 errors in docstrings - pandas.errors: SettingWithCopyWa…
72315bd 
…rning, SpecificationError, UndefinedVariableError
@mroeschke mroeschke added the Docs label Jan 21, 2024
@mroeschke mroeschke added this to the 3.0 milestone Jan 21, 2024
@mroeschke mroeschke merged commit 567c789 into pandas-dev:main Jan 21, 2024
@mroeschke
Copy link
Member

Thanks @jordan-d-murphy

@jordan-d-murphy jordan-d-murphy deleted the issue#56804_12 branch January 22, 2024 00:19
@jordan-d-murphy jordan-d-murphy mentioned this pull request Jan 22, 2024
Closed
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
@jordan-d-murphy @pmhatre1
DOC: fix EX03 errors in docstrings - pandas.errors: SettingWithCopyWa…
5e024c1 
…rning, SpecificationError, UndefinedVariableError (pandas-dev#56989)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mroeschke mroeschke mroeschke approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
3.0
Development

Successfully merging this pull request may close these issues.
2 participants
@jordan-d-murphy @mroeschke