DOC: to_json for stream object

[loicdiridollou]

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/reference/api/pandas.DataFrame.to_json.html

Documentation problem

Currently the docs for to_jsonmethod only mentions about file-like object, yet we can pass buffer which are more like stream object. This was raised on the stubs repo (pandas-dev/pandas-stubs#1179).
Should the docs reflect the ability of not just file-like but also stream-like? It seems to be supported at run time for sure.

Thanks!

Suggested fix for documentation

Add mention of stream-like object for the path_or_buf argument.

[rhshadrach]

From https://docs.python.org/3/library/io.html

The io module provides Python’s main facilities for dealing with various types of I/O. There are three main types of I/O: text I/O, binary I/O and raw I/O. These are generic categories, and various backing stores can be used for each of them. A concrete object belonging to any of these categories is called a file object. Other common terms are stream and file-like object.

pandas consistently uses file-like and I am seeing no occurrences of stream-like. I am negative on this change.

cc @Dr-Irv

[Dr-Irv]

@rhshadrach I was unaware that we define "file-like" to include streams, so I'm in agreement with you. Thanks for pointing that out. I'll close this.