Make the point in each of your sentences without using parentheses. Don't use parentheses in place of commas, to enclose a complete sentence, or to include unnecessary information or an afterthought.
You can use parentheses to introduce an abbreviation.
- Use the Splunk Search Processing Language (SPL) to search your data.
- Use SPL (the Splunk Search Processing Language) to search your data.
You can use parentheses when explaining that a step is optional in a task.
- (Optional) Provide the context for the task in a new paragraph.
- Optional: Provide the context for the task in a new paragraph.
- Provide the context for the task in a new paragraph (optional).
You can also use parentheses when writing about one or more fields in statistical commands and charting functions for SPL. See the following example:
- Use with
latest(x)to calculate the rate of increase.
Don't write a lowercase "s" or "es" in parentheses, "(s)" or "(es)", after a noun to indicate both singular and plural. Choose the best option for your documentation.
This documentation applies to the following versions of Splunk® Style Guide: current
Feedback submitted, thanks!