Skip to content

Commit

Permalink
Add code text formatting guidelines (#415)
Browse files Browse the repository at this point in the history
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Jan 17, 2024
1 parent 82f1cf8 commit fb45e33
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/sources/write/style-guide/style-conventions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,3 +269,13 @@ Use italics formatting (\_ in Markdown), to emphasize a specific word or phrase.
For example:

> The Prometheus data model is arranged into _metrics_ that consist of a _timestamp_ and a _sample_.
### Code

Use code formatting (\` in Markdown) to refer to:

- File names
- Configuration options
- User input
- Code in text/inline text
- Class and method names, status codes, and console output

0 comments on commit fb45e33

Please sign in to comment.