Document the unit of "start" and "length" for mentions and text styles (#1505)

The unit of UTF-16 code units is not necessarily obvious for users of
languages that index strings by Unicode code points. Provide a pointer
to an FAQ entry as well:

https://github.com/AsamK/signal-cli/wiki/FAQ#string-indexing-units

Closes #1504

Signed-off-by: Stephen Brennan <stephen@brennan.io>
This commit is contained in:
Stephen Brennan 2024-04-13 11:26:15 -07:00 committed by GitHub
parent 419beee29a
commit e5ebb732cb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 3 deletions

View file

@ -71,10 +71,12 @@ public class SendCommand implements JsonRpcLocalCommand {
.action(Arguments.storeTrue());
subparser.addArgument("--mention")
.nargs("*")
.help("Mention another group member (syntax: start:length:recipientNumber)");
.help("Mention another group member (syntax: start:length:recipientNumber). "
+ "Unit of start and length is UTF-16 code units, NOT Unicode code points.");
subparser.addArgument("--text-style")
.nargs("*")
.help("Style parts of the message text (syntax: start:length:STYLE)");
.help("Style parts of the message text (syntax: start:length:STYLE). "
+ "Unit of start and length is UTF-16 code units, NOT Unicode code points.");
subparser.addArgument("--quote-timestamp")
.type(long.class)
.help("Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.");