docs/checks/invalid_args.md in platformos-check-0.4.12 vs docs/checks/invalid_args.md in platformos-check-0.4.13

- old
+ new

@@ -1,14 +1,14 @@ -# Prevent providing invalid arguments in function, render and graphql tags Liquid (`InvalidArgs`) +# Prevent providing invalid arguments in `function`, `render` and `graphql` tags Liquid (`InvalidArgs`) -This check exists to prevent providing invalid arguments via `function`, `render` and `graphql` tags. +This check ensures that invalid arguments are not provided in `function`, `render`, and `graphql` tags in Liquid files. ## Examples -The following examples contain code snippets that either fail or pass this check. +The following examples show code snippets that either fail or pass this check: -### ✗ Fail +### ✗ Incorrect Code Example (Avoid using this): ```liquid {% comment %}app/graphql/my-query does not define invalid_argument{% endcomment %} {% graphql res = 'my-query', invalid_argument: 10 %} ``` @@ -19,20 +19,20 @@ ```liquid {% render res = 'my-partial', context: context %} ``` -### ✓ Pass +### ✓ Correct Code Example (Use this instead): ```liquid {% comment %}app/graphql/my-query defines defined_argument{% endcomment %} {% graphql res = 'my-query', defined_argument: 10 %} ``` -## Options +## Configuration Options -The following example contains the default configuration for this check: +The default configuration for this check: ```yaml InvalidArgs: enabled: true ``` @@ -40,17 +40,17 @@ | Parameter | Description | | --- | --- | | enabled | Whether the check is enabled. | | severity | The [severity](https://documentation.platformos.com/developer-guide/platformos-check/platformos-check#check-severity) of the check. | -## When Not To Use It +## Disabling This Check -It is not safe to disable this rule. +Disabling this check is not recommended. ## Resources - [platformOS GraphQL Reference](https://documentation.platformos.com/api-reference/graphql/glossary) - [Rule source][codesource] - [Documentation source][docsource] -[codesource]: /lib/platformos_check/checks/graphql_args.rb -[docsource]: /docs/checks/graphql_args.md +[codesource]: /lib/platformos_check/checks/invalid_args.rb +[docsource]: /docs/checks/invalid_args.md \ No newline at end of file