Process documentation review comments (#557)

frenck · Jan 12, 2024 · f24716e · f24716e
1 parent 863be89
commit f24716e
Show file tree

Hide file tree

Showing 36 changed files with 80 additions and 60 deletions.
diff --git a/documentation/areas.md b/documentation/areas.md
@@ -751,7 +751,7 @@ data:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/devices.md b/documentation/devices.md
@@ -161,7 +161,7 @@ data:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for these features. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/devices_entities.md b/documentation/devices_entities.md
@@ -107,7 +107,7 @@ But wait, there are more counters! The following sensors are also added:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for these features. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/entities.md b/documentation/entities.md
@@ -370,7 +370,7 @@ service: homeassistant.delete_all_orphaned_entities
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for these features. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations.md b/documentation/integrations.md
@@ -335,7 +335,7 @@ data:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for these features. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/_template.md b/documentation/integrations/_template.md
@@ -55,7 +55,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/automation.md b/documentation/integrations/automation.md
@@ -101,7 +101,7 @@ To resolve the raised issue, you can either remove the reference to the non-exis
 - Comma separated lists of entity IDs are not taken into consideration by Spook. It is advisable to convert these to an actual list in your automations.
   :::
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/blueprint.md b/documentation/integrations/blueprint.md
@@ -102,7 +102,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/cloud.md b/documentation/integrations/cloud.md
@@ -89,7 +89,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/group.md b/documentation/integrations/group.md
@@ -45,7 +45,7 @@ Spook inspects all groups created to find group member entities that no longer e
 
 To resolve the raised issue, you can either remove the missing entity from the group or fix the referenced source entity. Spook will automatically remove the repair issue once the issue is fixed.
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/input_number.md b/documentation/integrations/input_number.md
@@ -240,7 +240,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/input_select.md b/documentation/integrations/input_select.md
@@ -204,7 +204,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/integration.md b/documentation/integrations/integration.md
@@ -37,7 +37,7 @@ Spook inspects all Riemann sum integral created {term}`entities <entity>`, and l
 
 To resolve the raised issue, you can either remove the helper or fix the referenced source {term}`entity ID <entity id>`. Spook will automatically remove the repair issue once the issue is fixed.
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/lovelace.md b/documentation/integrations/lovelace.md
@@ -57,7 +57,7 @@ To resolve the raised issue, you can either remove the reference to the non-exis
 - Spook is not aware of all possible configuration for all possible cards. Especially with third-party cards, configuration can sometimes differ and Spook might not be able to detect the use of an unknown entity ID in such cases.
   :::
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/number.md b/documentation/integrations/number.md
@@ -240,7 +240,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/person.md b/documentation/integrations/person.md
@@ -187,7 +187,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/recorder.md b/documentation/integrations/recorder.md
@@ -162,7 +162,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/repairs.md b/documentation/integrations/repairs.md
@@ -329,7 +329,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/scene.md b/documentation/integrations/scene.md
@@ -45,7 +45,7 @@ Spook found an issue with a scene that is using non-existing entities.
 
 To resolve the raised issue, you can either remove the reference to the non-existing entity ID or fix the referenced entity ID. Spook will automatically remove the repair issue once the issue is fixed.
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/script.md b/documentation/integrations/script.md
@@ -100,7 +100,7 @@ To resolve the raised issue, you can either remove the reference to the non-exis
 - Comma separated lists of entity IDs are not taken into consideration by Spook. It is advisable to convert these to an actual list in your scripts.
   :::
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/select.md b/documentation/integrations/select.md
@@ -115,7 +115,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/switch_as_x.md b/documentation/integrations/switch_as_x.md
@@ -39,7 +39,7 @@ Spook inspects all Switch as X created entities, in case one of your existing he
 
 To resolve the raised issue, you can either remove the helper or fix the referenced source entity ID. Spook will automatically remove the repair issue once the issue is fixed.
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/timer.md b/documentation/integrations/timer.md
@@ -88,7 +88,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/integrations/zone.md b/documentation/integrations/zone.md
@@ -270,7 +270,7 @@ Some use cases for the enhancements Spook provides for this integration:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/misc.md b/documentation/misc.md
@@ -78,7 +78,7 @@ data:
 
 There are currently no known {term}`blueprints <blueprint>` or tutorials for the enhancements Spook provides for these features. If you created one or stumbled upon one, [please let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance this, for example, by adding a new service, entity, or repairs detection; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/template_engine.md b/documentation/template_engine.md
@@ -46,6 +46,26 @@ Calculate the SHA1 hash of a given value.
 
 [documentation](template_functions/sha1) 📚
 
+## SHA256
+
+Calculate the SHA256 hash of a given value.
+
+```
+{{ sha256("hash me") }}
+```
+
+[documentation](template_functions/sha256) 📚
+
+## SHA512
+
+Calculate the SHA512 hash of a given value.
+
+```
+{{ sha512("hash me") }}
+```
+
+[documentation](template_functions/sha512) 📚
+
 ### Shuffle
 
 Shuffles a list of items.
@@ -68,7 +88,7 @@ Reveals the type of a given value.
 
 [documentation](template_functions/typeof) 📚
 
-## Unix filename pattern filtering
+## Unix file name pattern filtering
 
 Filter a lists of texts against a pattern.
 
@@ -79,7 +99,7 @@ Filter a lists of texts against a pattern.
 
 [documentation](template_functions/fnmatch_filter) 📚
 
-## Unix filename pattern matching
+## Unix file name pattern matching
 
 Match text or a lists of texts against a pattern.
 
@@ -90,7 +110,7 @@ Match text or a lists of texts against a pattern.
 
 [documentation](template_functions/fnmatch) 📚
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance the Home Assistant template engine, for example, by adding a new template function; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).
 

diff --git a/documentation/template_functions.md b/documentation/template_functions.md
@@ -83,7 +83,7 @@ Reveals the type of a given value.
 
 [documentation](template_functions/typeof) 📚
 
-## Unix filename pattern filtering
+## Unix file name pattern filtering
 
 Filter a lists of texts against a pattern.
 
@@ -94,7 +94,7 @@ Filter a lists of texts against a pattern.
 
 [documentation](template_functions/fnmatch_filter) 📚
 
-## Unix filename pattern matching
+## Unix file name pattern matching
 
 Match text or a lists of texts against a pattern.
 

diff --git a/documentation/template_functions/flatten.md b/documentation/template_functions/flatten.md
@@ -79,7 +79,7 @@ Returns:
 
 ```{code-block} python
 :linenos:
-{{ [1, [2, [3]], 4, [5 , 6]] | shuffle }}
+{{ [1, [2, [3]], 4, [5 , 6]] | flatten }}
 ```
 
 Returns:
@@ -97,7 +97,7 @@ Example:
 
 ```{code-block} python
 :linenos:
-{{ shuffle([1, [2, [3]]], levels=1) }}
+{{ flatten([1, [2, [3]]], levels=1) }}
 ```
 
 Returns:
@@ -106,7 +106,7 @@ Returns:
 [1, 2, [3]]
 ```
 
-## Features requests, ideas and support
+## Features requests, ideas, and support
 
 If you have an idea on how to further enhance the Home Assistant template engine, for example, by adding a new template function; feel free to [let us know in our discussion forums](https://github.com/frenck/spook/discussions).