Skip to content

Commit

Permalink
Make minor typo and doc fixes
Browse files Browse the repository at this point in the history
* Fix IDL typo for "messag"
* Add missing javadoc param
* Fix selector ABNF tokens
  • Loading branch information
mtdowling authored and Michael Dowling committed Aug 9, 2022
1 parent 8c55cc1 commit 700141c
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source-2.0/spec/model-validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ Message templates
-----------------

A ``messageTemplate`` is used to create more granular error messages. The
template consists of literal spans and :token:`selector context value <selectors:selector_context_value>`
template consists of literal spans and :token:`selector context value <selectors:SelectorContextValue>`
templates (for example, ``@{id}``). A selector context value MAY be escaped
by placing a ``@`` before a ``@`` character (for example, ``@@`` expands to
``@``). ``@`` characters in the message template that are not escaped MUST
Expand Down
2 changes: 1 addition & 1 deletion docs/source-2.0/spec/selectors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1644,7 +1644,7 @@ Selectors are defined by the following ABNF_ grammar.
SelectorContextValue :"@{" `SelectorPath` "}"
SelectorScopedValues :`SelectorScopedValue` *("," `SelectorScopedValue`)
SelectorFunction :":" `smithy:Identifier` "(" `SelectorFunctionArgs` ")"
SelectorFunctionArgs :`selector` *("," `selector`)
SelectorFunctionArgs :`Selector` *("," `Selector`)
SelectorText :`SelectorSingleQuotedText` / `SelectorDoubleQuotedText`
SelectorSingleQuotedText :"'" 1*`SelectorSingleQuotedChar` "'"
SelectorDoubleQuotedText :DQUOTE 1*`SelectorDoubleQuotedChar` DQUOTE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ final class MetadataContainer {
*
* @param key Metadata key to set.
* @param value Value to set.
* @param events Where to add events as issues are encountered.
*/
void putMetadata(String key, Node value, List<ValidationEvent> events) {
Node previous = data.putIfAbsent(key, value);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ string title
]
)
@length(min: 1)
@deprecated(messag: "The enum trait is replaced by the enum shape in Smithy 2.0", since: "2.0")
@deprecated(message: "The enum trait is replaced by the enum shape in Smithy 2.0", since: "2.0")
list enum {
member: EnumDefinition
}
Expand Down

0 comments on commit 700141c

Please sign in to comment.