Docs/fixes (#188)

CHANGELOG.rst

@@ -16,6 +16,16 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.10
+----
+2024-09-27
+
+- For both ``StringTemplate`` and ``LazyStringTemplate`` the ``faker``
+  argument had become optional and positionally moved from first to the last
+  place.
+- Improve string templates.
+- Minor documentation improvements.
+
 0.9.9
 -----
 2024-09-27

Makefile

@@ -1,5 +1,5 @@
 # Update version ONLY here
-VERSION := 0.9.9
+VERSION := 0.10
 SHELL := /bin/bash
 # Makefile for project
 VENV := ~/.virtualenvs/fake.py/bin/activate

docs/creating_archives.rst

@@ -325,4 +325,4 @@ Using text templates:
     {domain_name}
     """
     # EML file
-    eml_file = FAKER.eml_file(content=StringTemplate(FAKER, template))
+    eml_file = FAKER.eml_file(content=StringTemplate(template))

docs/creating_docx.rst

@@ -120,9 +120,9 @@ Using text templates:
     """
     # DOCX file of 1 page
     docx_file_1 = FAKER.docx_file(
-        texts=[StringTemplate(FAKER, template)],
+        texts=[StringTemplate(template)],
     )
     # DOCX file of 10 pages
     docx_file_10 = FAKER.odt_file(
-        texts=[StringTemplate(FAKER, template) for _ in range(10)],
+        texts=[StringTemplate(template) for _ in range(10)],
     )

docs/creating_odt.rst

@@ -120,9 +120,9 @@ Using text templates:
     """
     # ODT file of 1 page
     odt_file_1 = FAKER.odt_file(
-        texts=[StringTemplate(FAKER, template)],
+        texts=[StringTemplate(template)],
     )
     # ODT file of 10 pages
     odt_file_10 = FAKER.odt_file(
-        texts=[StringTemplate(FAKER, template) for _ in range(10)],
+        texts=[StringTemplate(template) for _ in range(10)],
     )