Merge branch 'releases/1.1.x' into main

jlorieau · Aug 8, 2023 · f1f0d52 · f1f0d52
2 parents 2b3f5bf + 432afe9
commit f1f0d52
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -133,7 +133,7 @@ checks:
     desc: Check environment variables common to all development environments
 
     Path:
-      decs: Paths to search for executables
+      decs: Search paths for executables
       checkEnv: $PATH
 ```
 
@@ -144,18 +144,25 @@ or [toml](https://toml.io/en/) (e.g. ``.geomancy.toml``)
 desc = "Check environment variables common to all development environments"
 
     [checks.Environment.Path]
-    desc = "Paths to search for executables"
+    desc = "Search paths for executables"
     checkEnv = "$PATH"
 ```
 
+or [toml](https://toml.io/en/) with each check on 1 line (e.g. ``.geomancy.toml``)
+
+```toml
+[Checks.Environment]
+Path = {checkEnv = "$PATH", desc = "Search paths for executables"}
+```
+
 or [pyproject.toml](https://peps.python.org/pep-0621/)
 
 ```toml
 [tool.geomancy.checks.Environment]
 desc = "Check environment variables common to all development environments"
 
     [tool.geomancy.checks.Environment.Path]
-    desc = "Paths to search for executables"
+    desc = "Search paths for executables"
     checkEnv = "$PATH"
 ```
 

diff --git a/changelog/48.bugfix.rst b/changelog/48.bugfix.rst
diff --git a/docs/about/changelog.rst b/docs/about/changelog.rst
@@ -9,6 +9,24 @@ deprecations section.
 
 .. towncrier release notes start
 
+`geomancy 1.1.3 <https://github.com/jlorieau/geomancy/tree/1.1.3>`_ - 2023-08-08
+================================================================================
+
+Bug Fixes
+---------
+
+- `#48 <https://github.com/jlorieau/geomancy/issues/48>`_. Fixed bug that would disallow parentheses within parentheses in Result stasuses
+
+
+`gomancy 1.1.3 <https://github.com/jlorieau/geomancy/tree/1.1.3>`_ - 2023-08-08
+===============================================================================
+
+Bug Fixes
+---------
+
+- `#48 <https://github.com/jlorieau/geomancy/issues/48>`_. Fixed bug that would disallow parentheses within parentheses in Result stasuses
+
+
 `geomancy 1.1.1 <https://github.com/jlorieau/geomancy/tree/1.1.1>`_ - 2023-08-05
 ================================================================================
 

diff --git a/docs/guides/tips_and_tricks.rst b/docs/guides/tips_and_tricks.rst
@@ -6,9 +6,9 @@ Tips and Tricks
 Unwanted environment substitution
 ---------------------------------
 
-Environment variables are substituted by default in the values passed to
-checks. This can be avoided by setting ``substitute`` to False or by
-using a literal with single quotes.
+Environment variables, denoted by strings starting with a ``$`` character, are
+substituted by default in the values passed to checks. This can be avoided by
+setting ``substitute`` to False or by using a literal with single quotes.
 
 .. tab-set::
 
@@ -50,8 +50,8 @@ Flat Checks Files
 -----------------
 
 Checks can be conveniently grouped by category, but this is not a strict
-requirement for checks files. For example, the following checks file
-includes checks at the root level.
+requirement for checks files. The following show file format examples
+with checks at the root level, with an example on putting each check on 1 line.
 
 .. tab-set::
 
@@ -82,3 +82,10 @@ includes checks at the root level.
             desc = "Check for 'pyproject.toml' file"
             checkPath = "examples/pyproject.toml"
             type = "file"
+
+    .. tab-item:: example 3 (toml, 1 line)
+
+        .. code-block:: toml
+
+            Geomancy = {checkPath = "examples/geomancy.toml", type = "file"}
+            Pyproject = {checkPath = "examples/pyproject.toml", type = "file"}
diff --git a/docs/usage/checks/aws/iam.rst b/docs/usage/checks/aws/iam.rst
@@ -1,6 +1,6 @@
 .. _checkAwsIam:
 
-checkAwsIam
+checkIam
 -----------
 
 .. automodule:: geomancy.checks.aws.iam
@@ -13,7 +13,7 @@ checkAwsIam
 
     ``checkAwsIam``:
         | Check the IAM account
-        | *aliases*: ``checkIAM``, ``CheckIAM``, ``checkAWSIAM``, ``checkAwsIAM``,
+        | *aliases*: ``CheckIAM``, ``checkAwsIam``, ``checkAWSIAM``, ``checkAwsIAM``,
           ``CheckAwsIAM``,
 
     ``root``: bool (Optional)

diff --git a/docs/usage/checks/aws/s3.rst b/docs/usage/checks/aws/s3.rst
@@ -1,7 +1,7 @@
 .. _checkAwsS3:
 
-checkAwsS3
-----------
+checkS3
+-------
 
 .. automodule:: geomancy.checks.aws.s3
   :noindex:
@@ -13,7 +13,7 @@ checkAwsS3
 
     ``checkAwsS3``: str
         | Check the given S3 bucket
-        | *aliases*: ``checkS3``, ``CheckS3``, ``checkAWSS3``, ``checkAwsS3``,
+        | *aliases*: ``CheckS3``, ``checkAWSS3``, ``checkAwsS3``,
           ``CheckAwsS3``
 
     ``private``: bool

diff --git a/geomancy/__init__.py b/geomancy/__init__.py
@@ -1,7 +1,7 @@
 from . import checks, config, environment
 
 # Project version
-__version__ = (1, 1, 2)  # Major, minor, patch, stage
+__version__ = (1, 1, 3)  # Major, minor, patch, stage
 
 
 def get_version(version=__version__):