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

improve the documentation on accessors #4657

Merged
merged 6 commits into from
Dec 13, 2020

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Dec 7, 2020

We currently have a example for a accessor class in our internals page, but we didn't explicitly say what we require of these classes. This PR adds that information, and also fixes the displayed text for the link to sphinx-autosummary-accessors.

@mathause
Copy link
Collaborator

mathause commented Dec 7, 2020

LGTM, I tried to come up with a sentence without the double "only" but wasn't happy either 😉

doc/internals.rst Outdated Show resolved Hide resolved
doc/internals.rst Outdated Show resolved Hide resolved
@keewis keewis merged commit bdba889 into pydata:master Dec 13, 2020
@keewis keewis deleted the accessors-documentation branch December 13, 2020 00:32
@keewis
Copy link
Collaborator Author

keewis commented Dec 13, 2020

thanks for the reviews, @dcherian, @mathause.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on accessors?
3 participants