Skip to content

DOC: df.to_html documentation incorrectly contains min_rows optional param #44304

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

Closed
1 task done
naterush opened this issue Nov 3, 2021 · 1 comment · Fixed by #44331 or #44506
Closed
1 task done

DOC: df.to_html documentation incorrectly contains min_rows optional param #44304

naterush opened this issue Nov 3, 2021 · 1 comment · Fixed by #44331 or #44506
Labels
Docs IO HTML read_html, to_html, Styler.apply, Styler.applymap
Milestone

Comments

@naterush
Copy link

naterush commented Nov 3, 2021

  • I have checked that the issue still exists on the latest versions of the docs on master here

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_html.html

Documentation problem

The documentation contains an optional parameter min_rows, but the source code shows that no option is supported. See source code here.

Verify this optional param is not supported with the following code:

import pandas as pd
df = pd.DataFrame({'data': [1, 2, 3]})
df.to_html(max_rows=2, min_rows=1)

Which outputs the error

      1 import pandas as pd
      2 df = pd.DataFrame({'data': [1, 2, 3]})
----> 3 df.to_html(max_rows=2, min_rows=1)

TypeError: to_html() got an unexpected keyword argument 'min_rows'

Suggested fix for documentation

Remove the min_rows optional param from this documentation.

@naterush naterush added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 3, 2021
@phofl phofl added IO HTML read_html, to_html, Styler.apply, Styler.applymap and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 3, 2021
@jreback jreback added this to the 1.4 milestone Nov 6, 2021
@naterush
Copy link
Author

Woo woo, thanks :0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO HTML read_html, to_html, Styler.apply, Styler.applymap
Projects
None yet
3 participants