Skip to content

STY+CI: check for private function access across modules #36144

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

Merged
merged 1 commit into from
Sep 5, 2020

Conversation

jbrockmendel
Copy link
Member

The added checks here are broken off from #36055.

@jreback jreback added the Code Style Code style, linting, code_checks label Sep 5, 2020
@jreback jreback added this to the 1.2 milestone Sep 5, 2020
@jreback jreback merged commit 6e28008 into pandas-dev:master Sep 5, 2020
@jreback
Copy link
Contributor

jreback commented Sep 5, 2020

nice!

@jbrockmendel jbrockmendel deleted the sty-private-2 branch September 5, 2020 18:50
jbrockmendel added a commit to jbrockmendel/pandas that referenced this pull request Sep 8, 2020
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
@MarcoGorelli
Copy link
Member

MarcoGorelli commented Apr 12, 2021

Hi @jbrockmendel - I have a question about this check - why only check for function calls?

Specifically, should this (generic._shared_docs)

from pandas.core import generic
from pandas.io.common import get_handle
@doc(storage_options=generic._shared_docs["storage_options"])

not count as a private import across modules?

@jbrockmendel
Copy link
Member Author

Specifically, should this (generic._shared_docs) not count as a private import across modules?

It should, we just whitelisted it in the code check. I think we did that out of convenience more than any principled choice, so I'd be fine with changing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants