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

source links in stable API reference link to code on main branch #8343

Closed
stinodego opened this issue Apr 19, 2023 · 1 comment
Closed

source links in stable API reference link to code on main branch #8343

stinodego opened this issue Apr 19, 2023 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation python Related to Python Polars

Comments

@stinodego
Copy link
Member

The Python API reference has a handy link for finding the source code associated with each documented class/function. However, after splitting our docs into stable (latest release) and dev (current main branch), this functionality is no longer accurate for the stable docs. The link always points to the main branch, instead of the code for the latest release.

The code for this functionality lives here and was introduced by me in this PR.

Fixing this is not trivial. We must somehow determine whether we're building docs for stable or for dev. I believe pandas does this through their __version__ specifier. We should find a way that works for us.

This issue was pointed out to me by @corneliusroemer.

@stinodego stinodego added bug Something isn't working documentation Improvements or additions to documentation python Related to Python Polars labels Apr 19, 2023
@stinodego
Copy link
Member Author

This was resolved in #10542

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Development

No branches or pull requests

1 participant