From ae369125b701a5c0d0b7810c6d00a0f6bf92ce0e Mon Sep 17 00:00:00 2001 From: JoaoPCoelho Date: Mon, 15 Aug 2022 23:09:22 -0300 Subject: [PATCH 1/3] Fixing typos in rasa-sdk documentation --- docs/docs/events.mdx | 2 +- docs/docs/validation-action.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/events.mdx b/docs/docs/events.mdx index be33b729a..be6a5f542 100644 --- a/docs/docs/events.mdx +++ b/docs/docs/events.mdx @@ -333,7 +333,7 @@ Logs an action called by the bot. Only the action itself is logged; the events t **Automatic Tracking**: -* Any action (including custom actions and responses) that is called, even if the action does not execute succesfully. +* Any action (including custom actions and responses) that is called, even if the action does not execute successfully. This event is not usually returned explicitly by a custom action. diff --git a/docs/docs/validation-action.mdx b/docs/docs/validation-action.mdx index dc602d532..8f7ee404f 100644 --- a/docs/docs/validation-action.mdx +++ b/docs/docs/validation-action.mdx @@ -234,7 +234,7 @@ The method `required_slots` will return the `domain_slots` which is a list of al ##### FormValidationAction.next_requested_slot The method `next_requested_slot` will set the value of `REQUESTED_SLOT` to the next unset slot only if the -`required_slots` method was overriden by the custom action subclassing `FormValidationAction`. +`required_slots` method was overridden by the custom action subclassing `FormValidationAction`. If users didn't override `required_slots` then we'll let the `FormAction` within Rasa Open Source request the next slot, and the method will return `None`. From 38625a18d216b176e19a54b138905d1d2a368f52 Mon Sep 17 00:00:00 2001 From: JoaoPCoelho Date: Mon, 15 Aug 2022 23:09:52 -0300 Subject: [PATCH 2/3] Fixing typos in rasa-sdk code files --- docs/plugins/included_source.js | 2 +- rasa_sdk/cli/arguments.py | 2 +- rasa_sdk/interfaces.py | 2 +- tests/test_forms.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/plugins/included_source.js b/docs/plugins/included_source.js index 8880ab0c0..44a17b1c8 100644 --- a/docs/plugins/included_source.js +++ b/docs/plugins/included_source.js @@ -88,7 +88,7 @@ async function getIncludedSources(options) { contained in `versioned_docs/version-xxx/sources/...`. This is what this function does. Options: - - docsDir: the directory containing the versionned docs files + - docsDir: the directory containing the versioned docs files - relativeSourceDir: the directory that will contain the included sources - include: list of patterns to look for doc files */ diff --git a/rasa_sdk/cli/arguments.py b/rasa_sdk/cli/arguments.py index 0e1dbe78c..d6cc5e210 100644 --- a/rasa_sdk/cli/arguments.py +++ b/rasa_sdk/cli/arguments.py @@ -47,7 +47,7 @@ def add_endpoint_arguments(parser): "--ssl-password", default=None, help="If your ssl-keyfile is protected by a password, you can specify it " - "using this paramer.", + "using this parameter.", ) parser.add_argument( "--auto-reload", diff --git a/rasa_sdk/interfaces.py b/rasa_sdk/interfaces.py index d4ec22194..176492856 100644 --- a/rasa_sdk/interfaces.py +++ b/rasa_sdk/interfaces.py @@ -70,7 +70,7 @@ def __init__( @property def active_form(self) -> Dict[Text, Any]: warnings.warn( - "Use of `active_form` is deprecated. Please use `active_loop insteaad.", + "Use of `active_form` is deprecated. Please use `active_loop instead.", DeprecationWarning, ) return self.active_loop diff --git a/tests/test_forms.py b/tests/test_forms.py index 433e06882..8b36e9a99 100644 --- a/tests/test_forms.py +++ b/tests/test_forms.py @@ -275,7 +275,7 @@ def validate_slot1( ) assert not warnings - # validation shoudn't run because `TestSlotValidationAction` implements + # validation shouldn't run because `TestSlotValidationAction` implements # `FormValidationAction` and `slot1` is not assigned to any form assert events == [] From 979e14fa01fcaa8c2b2ea610094cfb7489bb8dc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Paulo=20Coelho?= <40813329+JoaoP-Coelho@users.noreply.github.com> Date: Wed, 14 Sep 2022 15:52:27 -0300 Subject: [PATCH 3/3] Adding changelog --- changelog/833.misc.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog/833.misc.md diff --git a/changelog/833.misc.md b/changelog/833.misc.md new file mode 100644 index 000000000..3f9d2be5d --- /dev/null +++ b/changelog/833.misc.md @@ -0,0 +1 @@ +Fixed some 8 spelling errors in rasa-sdk documentation and code.