Apply suggestions from code review

Co-authored-by: Sebastian <[email protected]>

Author: kamil-certat

CHANGELOG.md

@@ -15,7 +15,7 @@ CHANGELOG
 ### Core
 - `intelmq.lib.message`: For invalid message keys, add a hint on the failure to the exception: not allowed by configuration or not matching regular expression (PR#2398 by Sebastian Wagner).
 - `intelmq.lib.exceptions.InvalidKey`: Add optional parameter `additional_text` (PR#2398 by Sebastian Wagner).
-- Change the way we discover bots to allow easy extending based on the entry point name. (PR by Kamil Mankowski)
+- Change the way we discover bots to allow easy extending based on the entry point name. (PR#2413 by Kamil Mankowski)
 
 ### Development
 
@@ -32,7 +32,7 @@ CHANGELOG
 
 ### Documentation
 - Add a readthedocs configuration file to fix the build fail (PR#2403 by Sebastian Wagner).
-- Add a guide of developing extensions packages (PR by Kamil Mankowski)
+- Add a guide of developing extensions packages (PR#2413 by Kamil Mankowski)
 
 ### Packaging
 

contrib/example-extension-package/mybots/bots/collectors/custom/collector.py

@@ -8,7 +8,7 @@
 
 class ExampleAdditionalCollectorBot(CollectorBot):
     """
-    This is an example bot provided by extension package
+    This is an example bot provided by an extension package
     """
 
     def process(self):

contrib/example-extension-package/setup.py

@@ -11,7 +11,7 @@
 # Instead of the bot-autodiscovery below, you can also just manually declare entrypoints
 # (regardless of packaging solution, even in pyproject.toml etc.), e.g.:
 #
-# intelmq.bots.collectors.custom.collector = mybots.bots.collectors.custom.collector:BOT.run
+# 'intelmq.bots.collectors.custom.collector = mybots.bots.collectors.custom.collector:BOT.run'
 #
 # Important is:
 #  - entry point has to start with `intelmq.bots.{type}` (type: collectors, experts, parsers, outputs)

docs/dev/guide.rst

@@ -896,14 +896,14 @@ Creating extensions packages
 ****************************
 
 IntelMQ supports adding additional bots using your own independent packages. You can use this to
-add a new integration that is special to you, or cannot be integrated for some reason
-into the main IntelMQ repository.
+add a new integration that is special to you, or cannot be integrated
+into the main IntelMQ repository for some reason.
 
 Building an extension package
 =============================
 
-A simple example of the package can be found in ``contrib/example-extension-package``. In order to
-bots to work with IntelMQ, you need to ensure that
+A simple example of the package can be found in ``contrib/example-extension-package``. To make your custom
+bots work with IntelMQ, you need to ensure that
 
  - your bot's module exposes a ``BOT`` object of the class inherited from ``intelmq.lib.bot.Bot``
    or its subclasses,
@@ -912,7 +912,7 @@ bots to work with IntelMQ, you need to ensure that
    the name of the group (collectors, experts, outputs, parsers), and then your original name.
    The entry point must point to the ``BOT.run`` method,
  - the module in which the bot resides must be importable by IntelMQ (e.g. installed in the same
-   virtualv).
+   virtualenv, if you use them).
 
 Apart from these requirements, your package can use any of the usual package features. We strongly
 recommend following the same principles and main guidelines as the official bots. This will ensure
@@ -948,7 +948,7 @@ file would then have the following section:
    [project.scripts]
    intelmq.bots.collectors.awesome.special = "awesome_bots.special:BOT.run"
 
-Once you installed your package, you can run ``intelmqctl list bots`` to check if your bot was
+Once you have installed your package, you can run ``intelmqctl list bots`` to check if your bot was
 properly registered.
 
 *************