aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Brockus <55331536+michaelbrockus@users.noreply.github.com>2020-08-07 15:36:02 -0700
committerGitHub <noreply@github.com>2020-08-08 01:36:02 +0300
commit352f05fe7cd8504923e1582f7774756f670bd4c4 (patch)
tree5437c6c74a5da655ade5246128baee1cce1bdc80 /docs
parent8e98819b0699d3277197148dc7bcc2c2c7e528b6 (diff)
downloadmeson-352f05fe7cd8504923e1582f7774756f670bd4c4.zip
meson-352f05fe7cd8504923e1582f7774756f670bd4c4.tar.gz
meson-352f05fe7cd8504923e1582f7774756f670bd4c4.tar.bz2
Written a new paragraph for var naming recommendation (#7531)
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Style-guide.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/markdown/Style-guide.md b/docs/markdown/Style-guide.md
index 960e60c..04a81e8 100644
--- a/docs/markdown/Style-guide.md
+++ b/docs/markdown/Style-guide.md
@@ -13,9 +13,12 @@ Always spaces.
## Naming Variable
-The most consistent naming convention is the snake case. Let say you would
-like to refer to your executable so something like `my_exe` would work or
-just `exe`.
+Snake case (stylized as `snake_case`) refers to the style of writing in which
+each space is replaced by an underscore (`_`) character, and the first letter of
+each word written in lowercase. It is the most common naming convention used
+in Meson build scripts as identifiers for variable.
+
+Let say you would like to refer to your executable so something like `my_exe`.
## Naming options