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.

Sign up for GitHub

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

Jump to bottom

DOC: read_clipboard docstring lacks code-formatting and links to other pandas functions/classes #53837

Closed
1 task done
tpaxman opened this issue Jun 25, 2023 · 3 comments · Fixed by #53838
Closed
1 task done

DOC: read_clipboard docstring lacks code-formatting and links to other pandas functions/classes #53837

tpaxman opened this issue Jun 25, 2023 · 3 comments · Fixed by #53838
Assignees
@tpaxman
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@tpaxman
Copy link
Contributor

tpaxman commented Jun 25, 2023

Pandas version checks

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

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.read_clipboard.html

Documentation problem

The read_clipboard function is missing back-ticks for code formatting in its docstring, as well as links to other pandas functions and classes.

Suggested fix for documentation

Add code formatting and :class:/:func: reference links where appropriate.
@tpaxman tpaxman added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 25, 2023
@tpaxman tpaxman mentioned this issue Jun 25, 2023
Merged
2 tasks
@tpaxman
Copy link
Contributor Author

tpaxman commented Jun 25, 2023

Noted based on running scripts/validate_docstrings.py that the read_clipboard docstring was missing an extended summary, a "see also" section and an examples section. Added those in as well along with the code formatting and reference links changes.

@tpaxman
Copy link
Contributor Author

tpaxman commented Jun 25, 2023

Toward #53674

@tpaxman tpaxman changed the title DOC: read_clipboard docstring missing code-formatting and links to other pandas functions/classes DOC: read_clipboard docstring lacks code-formatting and links to other pandas functions/classes Jun 26, 2023
@tpaxman
Copy link
Contributor Author

tpaxman commented Jun 26, 2023

Take

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tpaxman tpaxman

Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Milestone
No milestone
1 participant
@tpaxman