Merge pull request #348 from vanschelven/fix-184-document-write-to-template

RonnyPfannschmidt · web-flow · commit e863ca017571 · 2019-07-29T12:30:38.000+02:00
Documentation: add example usage of 'write_to_template' parameter
diff --git a/README.rst b/README.rst
@@ -318,7 +318,8 @@ Example configuration in ``setup.py`` format:
 
     setup(
         use_scm_version={
-            'write_to': 'version.txt',
+            'write_to': 'version.py',
+            'write_to_template': '__version__ = "{version}"',
             'tag_regex': r'^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$',
         }
     )

Original file line number	Diff line number	Diff line change
@@ -318,7 +318,8 @@ Example configuration in ``setup.py`` format:
`318`	`318`
`319`	`319`	`setup(`
`320`	`320`	`use_scm_version={`
`321`		`- 'write_to': 'version.txt',`
	`321`	`+ 'write_to': 'version.py',`
	`322`	`+ 'write_to_template': '__version__ = "{version}"',`
`322`	`323`	`'tag_regex': r'^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$',`
`323`	`324`	`}`
`324`	`325`	`)`