Skip to content

DOC: Clarify exceptions that are internal only #48687

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

Closed
wants to merge 1 commit into from

Conversation

mroeschke
Copy link
Member

@mroeschke mroeschke added Docs Error Reporting Incorrect or improved errors from pandas labels Sep 21, 2022
@mroeschke mroeschke added this to the 1.6 milestone Sep 22, 2022
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

lgtm, thanks @mroeschke

@jorisvandenbossche
Copy link
Member

jorisvandenbossche commented Sep 26, 2022

Personally, I would rather actually remove those from the public API: 1) a user should never have to use those (so having them in the public pandas.errors module serves no real purpose I think), 2) since they are internal implementation details, we should be free to change or remove them without worrying about compatibility.

My concern is that overtime the "internal" exceptions or warnings may unintentionally become publicly thrown, and at least users could still catch them through pandas.errors

We can maybe use some naming scheme to make it clearer those are actually internal? (eg _Internal_ prefix, so there is less chance we accidentally use it in a public location, or it's clearer something is wrong if you see this as a user).

@mroeschke mroeschke modified the milestones: 1.6, 2.0 Oct 13, 2022
@mroeschke
Copy link
Member Author

Sounds like we may need a different gameplan here so closing for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Error Reporting Incorrect or improved errors from pandas
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants