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.

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

DOC: Removed InvalidComparison and LossySetItemError from docs #54216

Merged
merged 9 commits into from
Jul 25, 2023

Conversation

DeaMariaLeon
Copy link
Member

@DeaMariaLeon DeaMariaLeon commented Jul 21, 2023

Towards #37875

#48088
#48687

@jorisvandenbossche @mroeschke : Could you comment if this is OK please? thanks.
Suggested by @MarcoGorelli

@DeaMariaLeon DeaMariaLeon added this to the 2.1 milestone Jul 21, 2023
@mroeschke
Copy link
Member

I'm still slightly concerned that overtime that these exceptions could leak in public APIs. Maybe it's good to document that they should be internal errors?

@DeaMariaLeon
Copy link
Member Author

Do you mean put them back to the documentation and write a note?

@mroeschke
Copy link
Member

Do you mean put them back to the documentation and write a note?

Yes, I would be partial to keep them in the docs and note in the docstrings that they are internal errors

@MarcoGorelli
Copy link
Member

maybe we should just add these to

IGNORE_VALIDATION = {
"Styler.env",
"Styler.template_html",
"Styler.template_html_style",
"Styler.template_html_table",
"Styler.template_latex",
"Styler.template_string",
"Styler.loader",
}

and note in the docstring that they're private and get re-raised, and not add examples to them

@DeaMariaLeon
Copy link
Member Author

@MarcoGorelli stylers? shouldn't we do it for errors?

@MarcoGorelli
Copy link
Member

yeah I mean to add these two errors to that set

scripts/validate_docstrings.py Outdated Show resolved Hide resolved
pandas/errors/__init__.py Outdated Show resolved Hide resolved
pandas/errors/__init__.py Outdated Show resolved Hide resolved
@DeaMariaLeon
Copy link
Member Author

DeaMariaLeon commented Jul 25, 2023

It looks green @MarcoGorelli ...
edit: I think I have to merge again

@MarcoGorelli
Copy link
Member

edit: I think I have to merge again

hey - was there a merge conflict? if not, no need to merge

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @DeaMariaLeon

@MarcoGorelli MarcoGorelli merged commit b8e4a3e into pandas-dev:main Jul 25, 2023
32 checks passed
@DeaMariaLeon DeaMariaLeon deleted the Jul21 branch July 25, 2023 09:20
jamie-harness pushed a commit to jamie-harness/pandas1 that referenced this pull request Jul 26, 2023
…s-dev#54216)

* Removed InvalidComparison and LossySetItemError from docs

* Revert "Removed InvalidComparison and LossySetItemError from docs"

This reverts commit b9cf502.

* internal errors

* Examples to Notes on docstring

* removed extra lines

* merge w main and code_check change
jamie-harness added a commit to jamie-harness/pandas1 that referenced this pull request Jul 26, 2023
…s-dev#54216) (#18)

* Removed InvalidComparison and LossySetItemError from docs

* Revert "Removed InvalidComparison and LossySetItemError from docs"

This reverts commit b9cf502.

* internal errors

* Examples to Notes on docstring

* removed extra lines

* merge w main and code_check change

Co-authored-by: Dea María Léon <deamarialeon@gmail.com>
jamie-harness pushed a commit to jamie-harness/pandas1 that referenced this pull request Jul 26, 2023
…s-dev#54216)

* Removed InvalidComparison and LossySetItemError from docs

* Revert "Removed InvalidComparison and LossySetItemError from docs"

This reverts commit b9cf502.

* internal errors

* Examples to Notes on docstring

* removed extra lines

* merge w main and code_check change
jamie-harness added a commit to jamie-harness/pandas1 that referenced this pull request Jul 26, 2023
…s-dev#54216) (#30)

* Removed InvalidComparison and LossySetItemError from docs

* Revert "Removed InvalidComparison and LossySetItemError from docs"

This reverts commit b9cf502.

* internal errors

* Examples to Notes on docstring

* removed extra lines

* merge w main and code_check change

Co-authored-by: Dea María Léon <deamarialeon@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants