Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF


Although there are many rules for when to use a comma, these are the most common in Splunk documentation:

Scenario Example
To separate a list of 3 or more words or word groups. This type of comma is known as the serial, or Oxford, comma. Generate reports, views, and dashboards.

I'd like to thank my parents, Mother Teresa, and the pope.

To separate adjectives when they each modify the noun independently. The feature groups the extracted fields into a single, ordered sequence.
To offset appositives from the rest of the sentence. Use wiki markup when you don't have any elements, such as code or a table, following a step.
After a prepositional phrase. After reviewing the document, I had a chance to compile a list of reading material.

Don't use commas to separate 2 verb phrases that modify the same subject.

I collected the various pieces of documentation and forwarded them to the appropriate parties.
I collected the various pieces of documentation, and forwarded them to the appropriate parties.
Last modified on 25 May, 2023

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

Was this documentation topic helpful?

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