Skip to content

Commit 1605174

Browse files
author
Alan Christie
committed
docs: README tweak
1 parent af8646a commit 1605174

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,19 @@ formed from the definition YAML file) with::
4040
>>> error: Optional[str] = decoder.validate_manifest_schema(manifest)
4141
>>> error: Optional[str] = decoder.validate_job_schema(job_definition)
4242

43-
And run the decoder with:
43+
And you can decode encoded fields within the job definition.
44+
Here we're decoding the job's 'command' using a map of variables and their
45+
values::
4446

45-
>>> decoded, success = decoder.decode(text, variables, 'command', decoder.TextEncoding.JINJA2_3_0)
47+
>>> decoded, success = decoder.decode(definition['command'],
48+
variables,
49+
'command',
50+
decoder.TextEncoding.JINJA2_3_0)
4651

47-
A method exists to generate a Data Manger Job documentation URL
52+
A method also exists to generate a Data Manger Job documentation URL
4853
for the supported repository types. For example, to get the
49-
auto-generated documentation URL for a GitHub repository-based
50-
job definition you can do this::
54+
auto-generated documentation URL for a job definition hosted in a GitHub
55+
repository you can do this::
5156

5257
>>> doc_url: str = decoder.get_job_doc_url("github",
5358
collection

0 commit comments

Comments
 (0)