DOC: missing path-like at path parameter in to_pickle()

[simon-spier0]

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.DataFrame.to_pickle.html

Documentation problem

Based on documentation, it accepts parameter path as str. Inside the to_pickle(), the path parameter is put to stringify_path() so it accepts path-like object actually.

Suggested fix for documentation

Adding path-like object to documentation removes warning in PyCharm.

[simonjayhawkins]

Thanks @simon-spier0 for the report.

The path parameter of NDFrame.to_pickle is also missing a type annotation to match the docstring.

pandas/pandas/core/generic.py

Lines 2968 to 2971 in afc06e7

	def to_pickle(
	self,
	path,
	compression: CompressionOptions = "infer",

Inside the to_pickle(), the path parameter is put to stringify_path() so it accepts path-like object actually.

NDFrame.to_pickle dispatches to to_pickle in pandas/io/pickle.py where the accepted types are defined as filepath_or_buffer: FilePath | WriteBuffer[bytes]. (FilePath is defined in pandas._typing as FilePath = Union[str, "PathLike[str]"])

The type annotation for path in DataFrame.to_pickle should match the type annotation for filepath_or_buffer in pandas.io.pickle.to_pickle and should match the docstring too

contributions welcome.

[marco-georgaklis]

take