Skip to content

Commit 7d7a267

Browse files
Make the help text for write-by-id say the right thing about the value list. (#31884)
#20413 changed the value separator from comma to semicolon, but did not change the help text. Fixes #31854
1 parent f5a9a2d commit 7d7a267

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

examples/chip-tool/commands/clusters/WriteAttributeCommand.h

+5-2
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,8 @@ class WriteAttribute : public InteractionModelWriter, public ModelCommand, publi
195195
template <typename U = T, std::enable_if_t<std::is_same<U, std::vector<CustomArgument *>>::value, int> = 0>
196196
static const char * GetAttributeValuesDescription()
197197
{
198-
return "Comma-separated list of attribute values to write. Each value is represented as follows, depending on the type:\n"
198+
return "Semicolon-separated list of attribute values to write. Each value is represented as follows, depending on the "
199+
"type:\n"
199200
" * struct: a JSON-encoded object, with field ids as keys.\n"
200201
" * list: a JSON-encoded array of values.\n"
201202
" * null: A literal null.\n"
@@ -213,7 +214,9 @@ class WriteAttribute : public InteractionModelWriter, public ModelCommand, publi
213214
" a) The number directly, if it's not an integer.\n"
214215
" b) A string starting with \"d:\" followed by the number.\n"
215216
" * octet string: A string starting with \"hex:\" followed by the hex encoding of the bytes.\n"
216-
" * string: A string with the characters.";
217+
" * string: A string with the characters.\n"
218+
"\n"
219+
" Example values: '10;20', '10;\"u:20\"', '\"hex:aabbcc\";\"hello\"'.";
217220
}
218221

219222
static const char * GetTypedAttributeValuesDescription() { return "Comma-separated list of attribute values to write."; }

0 commit comments

Comments
 (0)