
Brackets
There are three kinds of brackets: angle brackets, curly braces, and square brackets.
Angle brackets ( < and > )
Use angle brackets as a placeholder for variables you want the user to enter.
- Correct
- Enter your user-specified domain in this format: https://<user-specified domain>.splunkcloud.com.
- Incorrect
- Enter your user-specified domain in this format: https://{user-specified domain}.splunkcloud.com.
- Enter your user-specified domain in this format: https://(user-specified domain).splunkcloud.com
- Enter your user-specified domain in this format: https://[user-specified domain].splunkcloud.com
You can also use angle brackets to indicate navigation or a series of menu item selections. See the following example:
- Select Save As > Saved search > Close.
Curly braces ( { and } )
Use curly braces only when they are part of a code sample or other string literal.
Square brackets ( [ and ] )
Use square brackets around a .conf file stanza name or within code.
- Correct
- Edit the
[splunktcp]
stanza. - Specify a subsearch that starts with this search command:
tag=dns query [search tag=malware]
.
- Incorrect
- Enter your user-specified domain in this format: https://[user-specified domain].splunkcloud.com.
PREVIOUS Apostrophe |
NEXT Colon |
This documentation applies to the following versions of Splunk® Style Guide: current
Feedback submitted, thanks!