Skip to content

[3.9] bpo-44544: [doc] list all textwrap func kwargs (GH-26999) #27425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions Doc/library/textwrap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ If you're just wrapping or filling one or two text strings, the convenience
functions should be good enough; otherwise, you should use an instance of
:class:`TextWrapper` for efficiency.

.. function:: wrap(text, width=70, **kwargs)
.. function:: wrap(text, width=70, *, initial_indent="", \
subsequent_indent="", expand_tabs=True, \
replace_whitespace=True, fix_sentence_endings=False, \
break_long_words=True, drop_whitespace=True, \
break_on_hyphens=True, tabsize=8, max_lines=None)

Wraps the single paragraph in *text* (a string) so every line is at most
*width* characters long. Returns a list of output lines, without final
Expand All @@ -30,7 +34,12 @@ functions should be good enough; otherwise, you should use an instance of
:func:`wrap` behaves.


.. function:: fill(text, width=70, **kwargs)
.. function:: fill(text, width=70, *, initial_indent="", \
subsequent_indent="", expand_tabs=True, \
replace_whitespace=True, fix_sentence_endings=False, \
break_long_words=True, drop_whitespace=True, \
break_on_hyphens=True, tabsize=8, \
max_lines=None)

Wraps the single paragraph in *text*, and returns a single string containing the
wrapped paragraph. :func:`fill` is shorthand for ::
Expand All @@ -41,7 +50,9 @@ functions should be good enough; otherwise, you should use an instance of
:func:`wrap`.


.. function:: shorten(text, width, **kwargs)
.. function:: shorten(text, width, *, fix_sentence_endings=False, \
break_long_words=True, break_on_hyphens=True, \
placeholder=' [...]')

Collapse and truncate the given *text* to fit in the given *width*.

Expand All @@ -65,7 +76,6 @@ functions should be good enough; otherwise, you should use an instance of

.. versionadded:: 3.4


.. function:: dedent(text)

Remove any common leading whitespace from every line in *text*.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
List all kwargs for :func:`textwrap.wrap`, :func:`textwrap.fill`, and
:func:`textwrap.shorten`. Now, there are nav links to attributes of
:class:`TextWrap`, which makes navigation much easier while minimizing
duplication in the documentation.