DOC: How to use storage_option param here to integrate with GCP bucket?

[purna135]

• closes DOC: How to use storage_option param here to integrate with GCP bucket? #42066
• Tests added and passed if fixing a bug or adding a new feature
• All code checks passed.
• Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

[purna135]

Hi @MarcoGorelli, I altered a few files, but there are still a few that offer a brief description of the storage options, as shown below.
Please let me know if these files need to be corrected as well.

pandas/pandas/io/formats/xml.py

Lines 85 to 87 in c24a3c8

	storage_options : dict, optional
	Extra options that make sense for a particular storage connection,
	e.g. host, port, username, password, etc.,

pandas/pandas/io/excel/_xlrd.py

Lines 20 to 21 in c24a3c8

	storage_options : dict, optional
	passed to fsspec for appropriate URLs (see ``_get_filepath_or_buffer``)

pandas/pandas/io/excel/_pyxlsb.py

Lines 28 to 29 in c24a3c8

	storage_options : dict, optional
	passed to fsspec for appropriate URLs (see ``_get_filepath_or_buffer``)

pandas/pandas/io/excel/_openpyxl.py

Lines 541 to 542 in c24a3c8

	storage_options : dict, optional
	passed to fsspec for appropriate URLs (see ``_get_filepath_or_buffer``)

pandas/pandas/io/excel/_odfreader.py

Lines 26 to 27 in c24a3c8

	storage_options : dict, optional
	passed to fsspec for appropriate URLs (see ``_get_filepath_or_buffer``)

pandas/pandas/io/xml.py

Lines 101 to 103 in c24a3c8

	storage_options : dict, optional
	Extra options that make sense for a particular storage connection,
	e.g. host, port, username, password, etc.,

[twoertwein]

Hi @MarcoGorelli, I altered a few files, but there are still a few that offer a brief description of the storage options, as shown below. Please let me know if these files need to be corrected as well.

If possible, it might be great to share the doc-strings between all of these methods. I think we already have shared docs for storage_options:

from pandas.util._decorators import doc
from pandas.core.shared_docs import _shared_docs

@doc(storage_options=_shared_docs["storage_options"])
def some_function():
    """
    {storage_options}
    """

[purna135]

I shared the doc-strings over all of the methods, with the exception of the _base file, which isn't a function.

pandas/pandas/io/excel/_base.py

Lines 275 to 283 in 0a7507d

	storage_options : dict, optional
	Extra options that make sense for a particular storage connection, e.g.
	host, port, username, password, etc., if using a URL that will
	be parsed by ``fsspec``, e.g., starting "s3://", "gcs://". An error
	will be raised if providing this argument with a local path or
	a file-like buffer. See the fsspec and backend storage implementation
	docs for the set of allowed keys and values.
	.. versionadded:: 1.2.0

[purna135]

Hello, @twoertwein. Could you please assist me in determining what I am doing incorrectly?

[twoertwein]

I shared the doc-strings over all of the methods, with the exception of the _base file, which isn't a function.

I think you can replace the section with {storage_options} and then add the decorator here

pandas/pandas/io/excel/_base.py

Line 425 in 0a7507d

def read_excel(

[twoertwein]

Hello, @twoertwein. Could you please assist me in determining what I am doing incorrectly?

What are you having trouble with? Some tests sometimes randomly fail, the faillures do not seem related to your changes.

[purna135]

What are you having trouble with? Some tests sometimes randomly fail, the faillures do not seem related to your changes.

Thank you : )
I had previously added {storage options} to the base file, but it failed several tests, so I redo the changes.
let me change and push it again.

[purna135]

Hello, @twoertwein. Please take a look at the adjustments I made.

[MarcoGorelli]

Hey @purna135 - did you try building this locally? I think it'd be helpful if you could post screenshots of the amended docstrings

[purna135]

Yes I have built this locally and bellow is the screanshot of amended docstrings.

[twoertwein]

Thanks @purna135! Let's wait for the CI to finish but otherwise looks good to me!

[purna135]

Should I share a screencap of the part where I replaced {...} with {{...}} to repair the unescaped braces error?

[purna135]

Thank you so much for your support and guidance, @twoertwein; as a newbie, it was extremely helpful.

[MarcoGorelli]

Thanks @purna135 , and thanks @twoertwein for reviewing!