-
-
Notifications
You must be signed in to change notification settings - Fork 18.2k
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
DOC: corrupted function signatures on stable #37813
Comments
One other difference is the sphinx version with which both docs are built (3.1.1 vs 3.3.1), but no idea if that would be the cause. |
I'll milestone this as 1.1.5 for now |
locally I have built the docs for both 1.1.5 and 1.2.0rc0. both created using Sphinx 3.3.1. So it appears that this is not a release environment issue. I think there is nothing more to do here, other than to check the function signatures before publishing the docs during the release process. |
ok leaving it on this tag, pls close if ok. |
Closing as confirmed that the issue is not present anymore. |
Location of the documentation
Stable (v1.1.4) docs.
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_parquet.html
Documentation problem
On stable (v1.1.4) there are corrupted function signatures in docs for these functions at least.
Instead of named arguments followed by kwargs there are only kwargs.
There is no such problem on dev docs.
For example, here https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.to_parquet.html?highlight=to_parquet#pandas.DataFrame.to_parquet
Suggested fix for documentation
I though that probably decorator
deprecate_kwargs
was causing problems (the functions concerned are decorated),but there is no such problem on dev docs, so the reason is not clear to me.
The text was updated successfully, but these errors were encountered: