Skip to content

Commit

Permalink
tweak open() docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
wbolster committed Feb 20, 2023
1 parent 3a5f02f commit 102df3f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions jsonlines/jsonlines.py
Original file line number Diff line number Diff line change
Expand Up @@ -596,12 +596,12 @@ def open(
"""
Open a jsonlines file for reading or writing.
This is a convenience function that opens a file, and wraps it in
either a :py:class:`Reader` or :py:class:`Writer` instance,
depending on the specified `mode`.
This is a convenience function to open a file and wrap it in either a
:py:class:`Reader` or :py:class:`Writer` instance, depending on the
specified `mode`.
Any additional keyword arguments will be passed on to the reader and
writer: see their documentation for available options.
Additional keyword arguments will be passed on to the reader and writer;
see their documentation for available options.
The resulting reader or writer must be closed after use by the
caller, which will also close the opened file. This can be done by
Expand Down

0 comments on commit 102df3f

Please sign in to comment.