Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the help text for write-by-id say the right thing about the value list. #31884

Merged
merged 1 commit into from
Feb 6, 2024
Merged

Make the help text for write-by-id say the right thing about the value list. #31884

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions examples/chip-tool/commands/clusters/WriteAttributeCommand.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,8 @@ class WriteAttribute : public InteractionModelWriter, public ModelCommand, publi
template <typename U = T, std::enable_if_t<std::is_same<U, std::vector<CustomArgument *>>::value, int> = 0>
static const char * GetAttributeValuesDescription()
{
return "Comma-separated list of attribute values to write. Each value is represented as follows, depending on the type:\n"
return "Semicolon-separated list of attribute values to write. Each value is represented as follows, depending on the "
"type:\n"
" * struct: a JSON-encoded object, with field ids as keys.\n"
" * list: a JSON-encoded array of values.\n"
" * null: A literal null.\n"
Expand All @@ -213,7 +214,9 @@ class WriteAttribute : public InteractionModelWriter, public ModelCommand, publi
" a) The number directly, if it's not an integer.\n"
" b) A string starting with \"d:\" followed by the number.\n"
" * octet string: A string starting with \"hex:\" followed by the hex encoding of the bytes.\n"
" * string: A string with the characters.";
" * string: A string with the characters.\n"
"\n"
" Example values: '10;20', '10;\"u:20\"', '\"hex:aabbcc\";\"hello\"'.";
}

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