Update RuleConfig documentation (#216)

* update config documentation

* update version, requirements and changelog

* fix format

* fix merge with master

Co-authored-by: Ramon <ramon.guimera@skyscanner.net>

CHANGELOG.md

@@ -7,6 +7,9 @@ All notable changes to this project will be documented in this file.
 - Add support to `EC2SecurityGroupOpenToWorldRule` for use cases where ports are not defined in the CloudFormation template. By default, this means all ports are included.
 ### Updates
 - Updated `EBSVolumeHasSSERule` to iterate only over `AWS::EC2::Volume` resources.
+- Update `RuleConfig` documentation.
+### Improvements
+- Bump `pycfmodel` to `0.18.0`.
 
 ## [1.7.0]
 ### Updates

cfripper/config/rule_config.py

@@ -6,5 +6,15 @@
 
 
 class RuleConfig(BaseModel):
+    """
+    Allows to overwrite the default behaviour of the rule, such as changing the rule mode and risk value.
+    Although this config has `None` as default values, `Rule` will use the following values as
+    default if no config is given.
+    ```
+    RULE_MODE = RuleMode.BLOCKING
+    RISK_VALUE = RuleRisk.MEDIUM
+    ```
+    """
+
     rule_mode: Optional[RuleMode] = None
     risk_value: Optional[RuleRisk] = None

docs/rule_config_and_filters.md

@@ -1,5 +1,10 @@
 ## Rule Config
 Allows to overwrite the default behaviour of the rule, such as changing the rule mode and risk value.
+Although this config has `None` as default values, `Rule` will use the following values as default if no config is given.
+```python3
+RULE_MODE = RuleMode.BLOCKING
+RISK_VALUE = RuleRisk.MEDIUM
+```
 
 {{ inline_source('cfripper.config.rule_config.RuleConfig') }}
 
@@ -65,4 +70,4 @@ Filter(
     rules={"TestRule"},
     debug=True
 )
-```
+```