DOC: Fixed to_pickle compression argument list 'gzip' > 'gz'

[ooojpeg]

Removed reference to gzip and replaced with correct extension of gz.

• closes DOC: to_pickle arguments for compression have a mistake (easy-fix) #35364

[rhshadrach]

The compression string here is specifying the compression and is used by the code:

# GZ Compression
if compression == "gzip":

This is making the docstring incorrect.

[ooojpeg]

@rhshadrach Outdated issue?

[rhshadrach]

As I commented in the issue, it seems like a good idea to me to have the details that are currently in DataFrame.to_csv also in DataFrame.to_pickle. These details make clear why the argument is "gzip" and not "gz".

[ooojpeg]

Added information as mentioned by @rhshadrach.

[twoertwein]

it might be useful to share documentation across all function that support the same compression (csv/pickle/json/...), similar to #37953. I didn't check whether the docstrings match exactly.

[jreback]

thanks @ooojpeg

@twoertwein yeah can you open issue(s) to share these doc-strings as you did before.