lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add sub categories to the language guide

Browse Source 
Hopefully this makes the longer sections easier to read.
This commit is contained in:
James Shubin
2019-01-12 11:44:58 -05:00
parent 75eba466c6
commit 5c92cef983
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/language-guide.md
View File

@@ -190,6 +190,8 @@ resource to control how it behaves. For example, setting the `content` parameter
of a `file` resource to the string `hello`, will cause the contents of that file of a `file` resource to the string `hello`, will cause the contents of that file
to contain the string `hello` after it has run. to contain the string `hello` after it has run.
##### Undefined parameters
For some parameters, there is a distinction between an unspecified parameter, For some parameters, there is a distinction between an unspecified parameter,
and a parameter with a `zero` value. For example, for the file resource, you and a parameter with a `zero` value. For example, for the file resource, you
might choose to set the `content` parameter to be the empty string, which would might choose to set the `content` parameter to be the empty string, which would
@@ -214,6 +216,8 @@ it evaluates to `true`, then the parameter will be used. If no `elvis` operator
is specified, then the parameter value will also be used. If the parameter is is specified, then the parameter value will also be used. If the parameter is
not specified, then it will obviously not be used. not specified, then it will obviously not be used.
##### Meta parameters
Resources may specify meta parameters. To do so, you must add them as you would Resources may specify meta parameters. To do so, you must add them as you would
a regular parameter, except that they start with `Meta` and are capitalized. Eg: a regular parameter, except that they start with `Meta` and are capitalized. Eg:
@@ -258,6 +262,8 @@ Please note that at the moment, you must specify a full metaparams struct, since
partial struct types are currently not supported in the language. Patches are partial struct types are currently not supported in the language. Patches are
welcome if you'd like to add this tricky feature! welcome if you'd like to add this tricky feature!
##### Internal edges
Resources may also declare edges internally. The edges may point to or from Resources may also declare edges internally. The edges may point to or from
another resource, and may optionally include a notification. The four properties another resource, and may optionally include a notification. The four properties
are: `Before`, `Depend`, `Notify` and `Listen`. The first two represent normal are: `Before`, `Depend`, `Notify` and `Listen`. The first two represent normal