@@ -30,7 +30,7 @@ Settings use the usual ".ini" syntax, but with some extra features:
30
30
31
31
- A prefix of ``file: `` reads the setting from a file.
32
32
33
- - A prefix of ``literal: `` reads a string literal from a source file.
33
+ - A prefix of ``literal: `` reads a literal data from a source file.
34
34
35
35
- Value substitutions can make a setting depend on another setting.
36
36
@@ -107,29 +107,29 @@ Literal Prefix
107
107
--------------
108
108
109
109
A ``literal: `` prefix means the setting value will be a literal string read
110
- from a source file. The setting provides a file name and variable name
111
- separated by colons::
110
+ from a source file. The setting provides a file name and value name separated
111
+ by colons::
112
112
113
113
[scriv]
114
114
version = literal: myproj/__init__.py: __version__
115
115
116
116
In this case, the file ``myproj/__init__.py `` will be read, and the
117
117
``__version__ `` value will be found and used as the version setting.
118
118
119
- It is also possible to specify a variable in a TOML file
120
- using periods to separate the sections and key names::
119
+ Currently Python, TOML and YAML files are supported for literals, but other
120
+ syntaxes can be supported in the future.
121
+
122
+ When using a TOML file, the value is specified using periods to separate the
123
+ sections and key names::
121
124
122
125
[scriv]
123
126
version = literal: pyproject.toml: project.version
124
127
125
- It is also possible to specify a variable in a YAML file
126
- using periods to access dictionary keys::
128
+ In a YAML file, use periods in the value name to access dictionary keys::
127
129
128
130
[scriv]
129
131
version = literal: galaxy.yaml: myproduct.versionString
130
132
131
- Currently Python, TOML and YAML files are supported for literals,
132
- but other syntaxes can be supported in the future.
133
133
134
134
Value Substitution
135
135
------------------
0 commit comments