Skip to content
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.

Sign up for GitHub

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

spellfix about n argument #108

Merged
merged 3 commits into from
Dec 15, 2023
Merged

spellfix about n argument #108

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
075417a
spellfix about ``n`` argument
jquast Dec 15, 2023
c92dde7
Suggest not to use the ``n`` argument
jquast Dec 15, 2023
ca767c8
Merge branch 'master' into jq/spellfix
jquast Dec 15, 2023
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
7 changes: 5 additions & 2 deletions wcwidth/wcwidth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,11 @@ def wcswidth(pwcs, n=None, unicode_version='auto'):
Given a unicode string, return its printable length on a terminal.

:param str pwcs: Measure width of given unicode string.
:param int n: When ``n`` is None (default), return the length of the
entire string, otherwise width the first ``n`` characters specified.
:param int n: When ``n`` is None (default), return the length of the entire
string, otherwise only the first ``n`` characters are measured. This
argument exists only for compatibility with the C POSIX function
signature. It is suggested instead to use python's string slicing
capability, ``wcswidth(pwcs[:n])``
:param str unicode_version: An explicit definition of the unicode version
level to use for determination, may be ``auto`` (default), which uses
the Environment Variable, ``UNICODE_VERSION`` if defined, or the latest
Expand Down