Splunk® Style Guide

Splunk Style Guide

The guidelines in the Splunk Style Guide establish best practices for writing technical documentation. Search docs.splunk.com to find documentation related to Splunk products.

Plurals in parentheses

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. In most cases, using the plural works best for understanding the sentence.

If it's important to include both singular and plural, try including the phrase "one or more".

Do this Don't do this
  • The endpoint returns the current webhook key.
  • The endpoint returns the current webhook keys.
  • The endpoint returns one or more of the current webhook keys.
  • The endpoint returns all of the current webhook keys.
 The endpoint returns the current webhook key(s).

For acceptable uses of parentheses in your writing, see Parentheses.

Last modified on 31 January, 2024
Misplaced modifiers   Possessive names and terms

This documentation applies to the following versions of Splunk® Style Guide: current

Acrobat logo Download manual
Acrobat logo Download this page

Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters