diff options
| author | Simon McVittie <smcv@collabora.com> | 2018-05-02 12:05:30 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@collabora.com> | 2018-05-02 12:43:10 +0100 |
| commit | b81df570c8e7a450cfcbd09663f2f15725906b7a (patch) | |
| tree | cb21ff6965c06eb4156a23be6241dde67d574ec0 /dbus_bindings/string.c | |
| parent | 780e299bc7cd72c30473162e266479656f3ab9ff (diff) | |
| download | dbus-python-b81df570c8e7a450cfcbd09663f2f15725906b7a.tar.gz | |
Improve documentation for Sphinx
Signed-off-by: Simon McVittie <smcv@collabora.com>
Diffstat (limited to 'dbus_bindings/string.c')
| -rw-r--r-- | dbus_bindings/string.c | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/dbus_bindings/string.c b/dbus_bindings/string.c index 8d34b4d..ce8f03d 100644 --- a/dbus_bindings/string.c +++ b/dbus_bindings/string.c @@ -203,21 +203,21 @@ PyTypeObject DBusPyObjectPath_Type = { /* Unicode string representation ==================================== */ PyDoc_STRVAR(String_tp_doc, -"A string represented using Unicode - a subtype of `unicode`.\n" +"dbus.String(value: str or unicode[, variant_level: int])\n" +"\n" +"A string represented using Unicode - a subtype of ``unicode`` (Python 2)\n" +"or ``str`` (Python 3).\n" "\n" "All strings on D-Bus are required to be valid Unicode; in the \"wire\n" "protocol\" they're transported as UTF-8.\n" "\n" "By default, when strings are converted from D-Bus to Python, they\n" -"come out as this class. If you prefer to get UTF-8 strings (as instances\n" +"come out as this class. In Python 2, if you prefer to get UTF-8 strings\n" +"(as instances\n" "of a subtype of `str`) or you want to avoid the conversion overhead of\n" "going from UTF-8 to Python's internal Unicode representation, see the\n" "documentation for `dbus.UTF8String`.\n" "\n" -"Constructor::\n" -"\n" -" String(value: str or unicode[, variant_level: int]) -> String\n" -"\n" "variant_level must be non-negative; the default is 0.\n" ); |
