[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: incomplete doc strings for add-text-properties
From: |
Richard Stallman |
Subject: |
Re: incomplete doc strings for add-text-properties |
Date: |
Sun, 12 Jan 2003 06:56:08 -0500 |
I suppose that START and END are buffer positions or markers if OBJECT
is a buffer, and 0-based indices if buffer is a string, where END set to
nil means the end of the string.
This information should be included in every doc string of those
functions, and in the elisp manual.
I put it in the manual; would you like to put it in the doc strings?
Also, I noticed that the substring function does not mention that the
index into the string is 0-based.
I don't think we should feel that the doc string must mention this
explicitly for functions that only operate on strings. That would be
too much work. However, adding it for substring won't take much work,
so please do it if you wish.
As an addition to my previous mail with the same subject, the doc string
of remove-text properties should refer to set-text-properties, which
must be used to remove all properties.
That is a good idea.