-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Removed InvalidComparison and LossySetItemError from docs #54216
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
Conversation
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? |
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 |
maybe we should just add these to pandas/scripts/validate_docstrings.py Lines 44 to 52 in f5a5c8d
and note in the docstring that they're private and get re-raised, and not add examples to them |
@MarcoGorelli stylers? shouldn't we do it for errors? |
yeah I mean to add these two errors to that set |
|
hey - was there a merge conflict? if not, no need to merge |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @DeaMariaLeon
…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
…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 <[email protected]>
…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
…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 <[email protected]>
Towards #37875
#48088
#48687
@jorisvandenbossche @mroeschke : Could you comment if this is OK please? thanks.
Suggested by @MarcoGorelli