File: api.rst

package info (click to toggle)
wcwidth 0.2.13%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 844 kB
  • sloc: python: 1,647; makefile: 17
file content (33 lines) | stat: -rw-r--r-- 948 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
==========
Public API
==========

This package follows SEMVER_ rules.  Therefore, for the functions of the below
list, you may safely use version dependency definition ``wcwidth<2`` in your
requirements.txt or equivalent. Their signatures will never change.

.. autofunction:: wcwidth.wcwidth

.. autofunction:: wcwidth.wcswidth

.. autofunction:: wcwidth.list_versions

.. _SEMVER: https://semver.org

===========
Private API
===========

These functions should only be used for wcwidth development, and not used by
dependent packages except with care and by use of frozen version dependency,
as these functions may change names, signatures, or disappear entirely at any
time in the future, and not reflected by SEMVER_ rules!

If stable public API for any of the given functions is needed, please suggest a
Pull Request!

.. autofunction:: wcwidth._bisearch

.. autofunction:: wcwidth._wcversion_value

.. autofunction:: wcwidth._wcmatch_version