Skip to content

DOC: add source link to properties #48054

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
Aug 12, 2022

Conversation

martinfleis
Copy link
Contributor

The current version of linkcode_resolve is unable to handle properties and ignore them. Hence there are no links to the source code for properties unlike for everything else. This add support to properties I did in geopandas/geopandas#2526 (comment) which is based on pandas code, so I thought it is worth contributing the enhancement back.

@mroeschke
Copy link
Member

Sounds reasonable. Could you show a before/after example of a docstring that is positively impacted?

@mroeschke mroeschke added the Docs label Aug 12, 2022
@martinfleis
Copy link
Contributor Author

Stuff like GeoSeries.size or GeoDataFrame.axes currently don't have a [source] link shown in the API docs:
Screenshot 2022-08-12 at 20 32 41

Docs rendered in this PR have the link to Github source code as all methods and functions already have.

Screenshot 2022-08-12 at 20 33 37

The link for this specific example points here.

@mroeschke mroeschke added this to the 1.5 milestone Aug 12, 2022
Copy link
Member

@mroeschke mroeschke left a comment

Choose a reason for hiding this comment

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

Great thanks! LGTM

@mroeschke mroeschke merged commit 03b4095 into pandas-dev:main Aug 12, 2022
@mroeschke
Copy link
Member

Thanks @martinfleis

@martinfleis martinfleis deleted the source_properties branch August 12, 2022 21:09
YYYasin19 pushed a commit to YYYasin19/pandas that referenced this pull request Aug 23, 2022
noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
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.

2 participants