summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2022-09-21 18:38:51 (GMT)
committerdgp <dgp@users.sourceforge.net>2022-09-21 18:38:51 (GMT)
commit9babdebe9d5537c0026d149ca8810b9ffad51d0d (patch)
tree9e18616f0d65948dd9dc92ca3aa7fb01dbe6ad3d
parent159cb3d31d8b70d7ef29798372421c08c9274a85 (diff)
downloadtcl-9babdebe9d5537c0026d149ca8810b9ffad51d0d.zip
tcl-9babdebe9d5537c0026d149ca8810b9ffad51d0d.tar.gz
tcl-9babdebe9d5537c0026d149ca8810b9ffad51d0d.tar.bz2
Update docs and comments to agree with TIP 623.
-rw-r--r--doc/StringObj.34
-rw-r--r--generic/tclStringObj.c4
2 files changed, 6 insertions, 2 deletions
diff --git a/doc/StringObj.3 b/doc/StringObj.3
index 7870b21..90678c4 100644
--- a/doc/StringObj.3
+++ b/doc/StringObj.3
@@ -211,7 +211,9 @@ appropriate range.
characters between \fIfirst\fR and \fIlast\fR (inclusive) in the
value's Unicode representation. If the value's Unicode
representation is invalid, the Unicode representation is regenerated
-from the value's string representation.
+from the value's string representation. If \fIfirst\fR < 0, then
+the returned string starts at the beginning of the value. If \fIlast\fR < 0,
+then the returned string ends at the end of the value.
.PP
\fBTcl_GetCharLength\fR returns the number of characters (as opposed
to bytes) in the string value.
diff --git a/generic/tclStringObj.c b/generic/tclStringObj.c
index b81e711..b109808 100644
--- a/generic/tclStringObj.c
+++ b/generic/tclStringObj.c
@@ -739,7 +739,9 @@ Tcl_GetUnicodeFromObj(
*
* Create a Tcl Object that contains the chars between first and last of
* the object indicated by "objPtr". If the object is not already a
- * String object, convert it to one.
+ * String object, convert it to one. If first is negative, the returned
+ * string start at the beginning of objPtr. If last is negative, the
+ * returned string ends at the end of objPtr.
*
* Results:
* Returns a new Tcl Object of the String type.