From 91b4def3bbc1c3fdb09a8fad247e54eedafb6edf Mon Sep 17 00:00:00 2001 From: Sean Madsen <sean@seanmadsen.com> Date: Wed, 18 Jan 2017 12:19:02 -0700 Subject: [PATCH] Style guide - clarifying formatting for machine readable text. Closes #53 --- docs/best-practices/documentation-style-guide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/best-practices/documentation-style-guide.md b/docs/best-practices/documentation-style-guide.md index 7bc1fb08..8a5e5855 100644 --- a/docs/best-practices/documentation-style-guide.md +++ b/docs/best-practices/documentation-style-guide.md @@ -105,6 +105,10 @@ descriptive names for images. Alternative Text (ALT Tags) should be included for every image. +### Machine-readable symbols + +Machine-readable symbols (e.g. files names, classes, functions, variables, database tables, database columns, commands, etc.) should be formatted either with inline monospace or preformatted code blocks (also in monospace). See the [markdown syntax](/markdownrules/#code) to use for such formatting. + ### URLs Sample links to specific CiviCRM URL paths should use `example.org` as the -- GitLab