DOC: inline docstring in CalamineReader #63571
Merged
+9
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xoxonut
changed the title
Contributor
Author
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Member
|
The docs build recently stopped running and has now been fixed on main. Can you merge main, then will take a look. |
Contributor
Author
|
Merged main and all checks passed. Ready for review! Thanks. |
mroeschke
requested changes
Jan 5, 2026
pandas/io/excel/_calamine.py
Outdated
Comment on lines
51
to
58
| Extra options that make sense for a particular storage connection, e.g. | ||
| host, port, username, password, etc. For HTTP(S) URLs the key-value pairs | ||
| are forwarded to ``urllib.request.Request`` as header options. For other | ||
| URLs (e.g. starting with "s3://", and "gcs://") the key-value pairs are | ||
| forwarded to ``fsspec.open``. Please see ``fsspec`` and ``urllib`` for more | ||
| details, and for more examples on storage options refer `here | ||
| <https://pandas.pydata.org/docs/user_guide/io.html? | ||
| highlight=storage_options#reading-writing-remote-files>`_. |
Member
There was a problem hiding this comment.
Can you indent this entire description?
Contributor
Author
There was a problem hiding this comment.
Thanks for the review! I've updated the indentation as requested.
mroeschke
approved these changes
Jan 6, 2026
Member
|
Thanks @xoxonut |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@Appender,@Substitution,@docwith inlined docstrings #62437doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.Replaced
@docdecorator with hardcoded docstrings inpandas/io/excel/_calamine.py:storage_optionsdocstring and removed the@docdecorator.doc,_shared_docs).