Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Dashes

Don't use dashes to list items. Use a bulleted list.

Hyphen (-)

Use a hyphen for compound adjectives that precede the noun they modify, and don't use a hyphen if the adjectives follow the noun they modify. Don't add spaces before or after the hyphen.

Correct
a case-sensitive username
the password is case sensitive
Incorrect
a case sensitive username
the password is case-sensitive

Em dash ( — )

Don't use em dashes in Splunk documentation. Keep your sentences short, and use two sentences or commas to separate breaks in thought.

En dash ( – )

Don't use en dashes in Splunk documentation.

Last modified on 23 September, 2019
PREVIOUS
Comma
  NEXT
Parentheses

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