Skip to content

DOC: update read_clipboard docstring to have proper formatting and all required sections. #53838

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 5 commits into from
Jun 26, 2023

Conversation

tpaxman
Copy link
Contributor

@tpaxman tpaxman commented Jun 25, 2023

Added code formatting, function and class references, as well as 'see also' and 'examples' sections.

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.

Nice! Thanks @tpaxman

@mroeschke mroeschke added Docs IO Data IO issues that don't fit into a more specific label labels Jun 26, 2023
@mroeschke mroeschke added this to the 2.1 milestone Jun 26, 2023
@mroeschke mroeschke merged commit 1cb9a6f into pandas-dev:main Jun 26, 2023
@mroeschke
Copy link
Member

Thanks @tpaxman

@tpaxman tpaxman deleted the issue53837 branch June 26, 2023 22:21
Daquisu pushed a commit to Daquisu/pandas that referenced this pull request Jul 8, 2023
…all required sections. (pandas-dev#53838)

* add code formatting and reference links to read_clipboard docstring

* add extended summary, see-also, and examples sections to ensure docstring is fully validated

* hide "pandas" from each :func: and :class: reference

* fix typos
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO Data IO issues that don't fit into a more specific label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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