From 1f4738d2adf4ce90a2384acc6e05ffd4f894825d Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Fri, 2 Sep 2022 14:55:46 +0200 Subject: [PATCH 1/2] docs: fix some typos across the documentation, readme and changelogs --- CHANGES-4x.rst | 2 +- CHANGES-5x.rst | 4 ++-- CHANGES-pre-v4.rst | 14 +++++++------- CHANGES.rst | 2 +- docs/user_guide/administration.rst | 2 +- docs/user_guide/backend_development/index.rst | 2 +- docs/user_guide/configuration/slackv3.rst | 4 ++-- docs/user_guide/flow_development/advanced.rst | 2 +- docs/user_guide/flow_development/index.rst | 2 +- .../plugin_development/backend_specifics.rst | 13 +++++++------ docs/user_guide/plugin_development/basics.rst | 2 +- docs/user_guide/plugin_development/dynaplugs.rst | 2 +- docs/user_guide/plugin_development/persistence.rst | 2 +- docs/user_guide/plugin_development/testing.rst | 2 +- docs/user_guide/provisioning.rst | 12 ++++++------ 15 files changed, 34 insertions(+), 33 deletions(-) diff --git a/CHANGES-4x.rst b/CHANGES-4x.rst index 5eae3d10b..a50278630 100644 --- a/CHANGES-4x.rst +++ b/CHANGES-4x.rst @@ -71,7 +71,7 @@ features: fixes: -- fixed imporlib/use pip as process (#835) (thx Raphael Wouters) +- fixed importlib/use pip as process (#835) (thx Raphael Wouters) - if pip is not found, don’t crash errbot - build_identifier to send message to IRC channels (thx mr Shu) diff --git a/CHANGES-5x.rst b/CHANGES-5x.rst index 2c0caf468..ed0c3083e 100644 --- a/CHANGES-5x.rst +++ b/CHANGES-5x.rst @@ -19,7 +19,7 @@ features: Honig) - Add support for specifying a custom log formatter (Thx Oz Linden) - Add Sentry transport support (thx Dylan Page) -- File transfert support (send_stream_request) on the Hipchat backend +- File transfer support (send_stream_request) on the Hipchat backend (thx Brad Payne) - Show user where they are in a flow (thx Elijah Roberts) - Help commands are sorted alphabetically (thx Fabian Chong) @@ -35,7 +35,7 @@ fixes: - Windows: Config directories as raw string (Thx defAnfaenger) - Windows: Repo Manager first time update (Thx Jake Shadle) - Slack: fix Slack identities to be hashable -- Hipchat: fix HicpChat Server XMPP namespace (Thx Antti Palsola) +- Hipchat: fix HipChat Server XMPP namespace (Thx Antti Palsola) - Hipchat: more aggressive cashing of user list to avoid API quota exceeds (thx Roman) diff --git a/CHANGES-pre-v4.rst b/CHANGES-pre-v4.rst index 937c747fc..9e85e48e8 100644 --- a/CHANGES-pre-v4.rst +++ b/CHANGES-pre-v4.rst @@ -180,7 +180,7 @@ Minor improvements ~~~~~~~~~~~~~~~~~~ - hipchat endpoint can be used (#348) -- XMPP server parameter can be overriden +- XMPP server parameter can be overridden - deep internal reorganisation of the bot: the most visible change is that internal commands have been split into internal plugins. - IRC backend: we have now a reconnection logic on disconnect and on kick (see ``IRC_RECONNECT_ON_DISCONNECT`` in the config file for example) @@ -269,7 +269,7 @@ features: - third party backends (they are plugins too) - completely revamped backup/restore feature. - hipchat endpoint can be used (#348) -- XMPP server parameter can be overriden +- XMPP server parameter can be overridden - Identifiers are now generic (not tight to XMPP anymore) fixes: @@ -308,7 +308,7 @@ features: - New serverless tox backend (see http://tox.im for more info) - New Presence callbacks with status messages etc. -- New file transfert support (upload and downloads) for selected backends +- New file transfer support (upload and downloads) for selected backends - New MUC management API - added err-githubhook to the official repo list (thx Daniele Sluijters) - added err-linksBot to the official repo list (thx Arnaud Vazard) @@ -402,7 +402,7 @@ features: - Added the !room create command for adhoc room creation (google talk) - Added sedbot to the official repos - Added support for plugin based webviews -- Add err-agressive-keepalive to the official repos +- Add err-aggressive-keepalive to the official repos - Allow botcmd's to yield values - Allow configuration of MESSAGE_SIZE_LIMIT @@ -430,7 +430,7 @@ features: - SSL support for webhook callbacks - JID unicode support - Per user command history (Thanks to Leonid S. Usov https://github.com/leonid-s-usov) -- HIDE_RESTRICTED_COMMANDS option added to filter out the non accessoble commands from the help (Thanks to Leonid S. Usov https://github.com/leonid-s-usov) +- HIDE_RESTRICTED_COMMANDS option added to filter out the non accessible commands from the help (Thanks to Leonid S. Usov https://github.com/leonid-s-usov) - err-markovbot has been added to the official plugins list (Thanks to Max Wagner https://github.com/MaxWagner) - the version parsing now supports beta, alpha, rc etc ... statuses @@ -508,7 +508,7 @@ fixes: - bot initiated messages were not correctly callbacked on jabber backend - !apropos was generating an unicode error thx to https://github.com/zoni for the fix -- corrected a serie of issues related to the sharedmiddleware on flask +- corrected a series of issues related to the sharedmiddleware on flask - fixed a regression on the IRC backend thx to https://github.com/nvdk for helping on those features: @@ -597,7 +597,7 @@ fixes: - corrected a threading issue that was preventing err to quit - the python shebangs lines where not generic - the config path is not inserted first so we don't conflict with other installs -- corrected a corruption of the configs on some persistance stores on shutdown +- corrected a corruption of the configs on some persistence stores on shutdown features: diff --git a/CHANGES.rst b/CHANGES.rst index d3be1d7e1..24c0baf17 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -77,7 +77,7 @@ features: fixes: - core/cli: failure when passing relative directory during --init (#1511) -- backend/xmpp: include message delayed for send/recieved messages (#1270) +- backend/xmpp: include message delayed for send/received messages (#1270) - backend/xmpp: "unexpected keyword argument 'wait'" when connecting (#1507) - docs: update broken readme link to plugin development docs (#1504) - close threadpool on exit (#1486) diff --git a/docs/user_guide/administration.rst b/docs/user_guide/administration.rst index 0ec0520ba..6622c47f2 100644 --- a/docs/user_guide/administration.rst +++ b/docs/user_guide/administration.rst @@ -42,7 +42,7 @@ Installing plugins Errbot plugins can be installed via these methods -* `!repos install` bot commnand +* `!repos install` bot command * Cloning a `GitHub `_ repository * Extracting a tar/zip file * Using pip diff --git a/docs/user_guide/backend_development/index.rst b/docs/user_guide/backend_development/index.rst index bd6195d6d..71c057834 100644 --- a/docs/user_guide/backend_development/index.rst +++ b/docs/user_guide/backend_development/index.rst @@ -13,7 +13,7 @@ Architecture ------------ Backends are just a specialization of the bot, they are what -is instanciated as the bot and are the entry point of the bot. +is instantiated as the bot and are the entry point of the bot. Following this logic a backend must inherit from :class:`~errbot.errBot.ErrBot`. diff --git a/docs/user_guide/configuration/slackv3.rst b/docs/user_guide/configuration/slackv3.rst index 61d57c76e..8e35ebcc3 100644 --- a/docs/user_guide/configuration/slackv3.rst +++ b/docs/user_guide/configuration/slackv3.rst @@ -46,13 +46,13 @@ When the following oauth scopes are detected, the RTM protocol will be used. Th "read" - Current token (OAuthv2) with Event API using the Event Subscriptions and Request URL. -- Current token (Oauthv2) with Event API using the Socket-mode client. +- Current token (OAuthv2) with Event API using the Socket-mode client. Backend Installation -------------------- These instructions are for errbot running inside a Python virtual environment. You will need to adapt these steps to your own errbot instance setup. -The virtual environment is created in `/opt/errbot/virtualenv` and errbot initialised in `/opt/errbot`. The extra backend directory is in `/opt/erbot/backend`. +The virtual environment is created in `/opt/errbot/virtualenv` and errbot initialised in `/opt/errbot`. The extra backend directory is in `/opt/errbot/backend`. 1. Create the errbot virtual environment diff --git a/docs/user_guide/flow_development/advanced.rst b/docs/user_guide/flow_development/advanced.rst index 70ddd5b3e..c708c50ee 100644 --- a/docs/user_guide/flow_development/advanced.rst +++ b/docs/user_guide/flow_development/advanced.rst @@ -93,7 +93,7 @@ In manual mode, the bot will tell the user about his 2 possible options to conti Making a looping graph ---------------------- -You can also perfectly reexecute a part of a graph in a "loop". You can branch directly the node object +You can also perfectly re-execute a part of a graph in a "loop". You can branch directly the node object instead of the command name in that case. .. code-block:: python diff --git a/docs/user_guide/flow_development/index.rst b/docs/user_guide/flow_development/index.rst index 5f134dfc6..1e89bc1b0 100644 --- a/docs/user_guide/flow_development/index.rst +++ b/docs/user_guide/flow_development/index.rst @@ -34,7 +34,7 @@ chatroom:: [...] In this guide we will explain the underlying concepts and basics of writing flows. -Prerequesite: you need to be familiar with the normal errbot plugin development. +Prerequisite: you need to be familiar with the normal errbot plugin development. .. toctree:: diff --git a/docs/user_guide/plugin_development/backend_specifics.rst b/docs/user_guide/plugin_development/backend_specifics.rst index 894769c30..1a53d81fc 100644 --- a/docs/user_guide/plugin_development/backend_specifics.rst +++ b/docs/user_guide/plugin_development/backend_specifics.rst @@ -10,10 +10,11 @@ Additionally, interacting directly with the bot internals gives you the freedom to control Errbot in highly specific ways that may not be officially supported. .. warning:: - The following instructions describe how to interface directly with the underlying bot object and clients of backends. - We offer no guarantees that these internal APIs are stable or that a given backend will continue to use a given client in the future. - The following information is provided **as-is** without any official support. - We can give **no** guarantees about API stability on the topics described below. + + The following instructions describe how to interface directly with the underlying bot object and clients of backends. + We offer no guarantees that these internal APIs are stable or that a given backend will continue to use a given client in the future. + The following information is provided **as-is** without any official support. + We can give **no** guarantees about API stability on the topics described below. Getting to the bot object @@ -24,8 +25,8 @@ For example, with the Telegram backend this would be an instance of :class:`~err .. code-block:: python - >>> type(self._bot) - + >>> type(self._bot) + To find out what methods each bot backend has, you can take a look at the documentation of the various backends in the :mod:`errbot.backends` package. diff --git a/docs/user_guide/plugin_development/basics.rst b/docs/user_guide/plugin_development/basics.rst index 021e8609e..832477d37 100644 --- a/docs/user_guide/plugin_development/basics.rst +++ b/docs/user_guide/plugin_development/basics.rst @@ -202,7 +202,7 @@ Packaging A plugin can be packaged and distributed through pypi.org. The errbot plugin system uses entrypoints in setuptools to find available plugins. -The two entrypoint avialable are +The two entrypoint available are * `errbot.plugins` - normal plugin and flows * `errbot.backend_plugins` - backend plugins for collaboration providers diff --git a/docs/user_guide/plugin_development/dynaplugs.rst b/docs/user_guide/plugin_development/dynaplugs.rst index a993977e5..da8113ba6 100644 --- a/docs/user_guide/plugin_development/dynaplugs.rst +++ b/docs/user_guide/plugin_development/dynaplugs.rst @@ -49,7 +49,7 @@ Once you have your series of Commands defined, you can package them in a plugin Refreshing a plugin ------------------- -You need to detroy and recreate the plugin to refresh its commands. +You need to destroy and recreate the plugin to refresh its commands. .. code-block:: python diff --git a/docs/user_guide/plugin_development/persistence.rst b/docs/user_guide/plugin_development/persistence.rst index 910f95ca9..568d535d1 100644 --- a/docs/user_guide/plugin_development/persistence.rst +++ b/docs/user_guide/plugin_development/persistence.rst @@ -9,7 +9,7 @@ How to use it Your plugin *is* the store, simply use self as a dictionary. -Here is a simple example for storing and retreiving a value from the store. +Here is a simple example for storing and retrieving a value from the store. .. code-block:: python diff --git a/docs/user_guide/plugin_development/testing.rst b/docs/user_guide/plugin_development/testing.rst index 8e58ca318..cba789098 100644 --- a/docs/user_guide/plugin_development/testing.rst +++ b/docs/user_guide/plugin_development/testing.rst @@ -36,7 +36,7 @@ And *myplugin.plug*: This does absolutely nothing shocking, but how do you test it? We need to interact with the bot somehow, send it `!mycommand` and validate the reply. -Fortunatly Errbot provides some help. +Fortunately, Errbot provides some help. diff --git a/docs/user_guide/provisioning.rst b/docs/user_guide/provisioning.rst index 1f6bbaeee..188b89406 100644 --- a/docs/user_guide/provisioning.rst +++ b/docs/user_guide/provisioning.rst @@ -34,12 +34,12 @@ It will give you on stdout a python dictionary of the core namespace like:: {'configs': {'Webserver': {'PORT': 8888}}} To read the values from a plugin storage, for example here from alimac/err-factoid you can do:: - - errbot --storage-get Factoid + + errbot --storage-get Factoid It will give you on stdout a similar output:: - {'FACTOID': {'fire': 'burns', 'water': 'wet'}} + {'FACTOID': {'fire': 'burns', 'water': 'wet'}} Writing values @@ -56,9 +56,9 @@ Checking back:: Changing facts in Factoid (note the merge is only on the first level so we change all FACTOID here):: - echo "{'FACTOID': {'errbot': 'awesome'}}" | errbot --storage-merge Factoid + echo "{'FACTOID': {'errbot': 'awesome'}}" | errbot --storage-merge Factoid - >>> !errbot? - errbot is awesome + >>> !errbot? + errbot is awesome You can use --storage-set in the same fashion but it will erase first the namespace before writing your values. From 3a66f7b0f8caffc8f001cd4477c50985e6ea29e0 Mon Sep 17 00:00:00 2001 From: Sijis Aviles Date: Thu, 22 Sep 2022 00:03:06 -0500 Subject: [PATCH 2/2] docs: add info to CHANGES --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 24c0baf17..870630d1a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -20,7 +20,7 @@ fixes: - backend/xmpp: fix forward type references (#1578) - chore: remove campfire references (#1584) - chore/setup: fix exception when installing on python <3.7 (#1585) -- docs: typos (#1589) +- docs: typos (#1589, #1594) v6.1.9 (2022-06-11)