Improve sentence style within documentation

Author: tornede

CHANGELOG.rst

@@ -21,11 +21,11 @@ Examples
 Fix
 ---
 
-- Start date is now set when pulling an experiment
-- Supported Python version is now >= 3.9
-- Changed row identification in ResultProcessor to experiment ID instead of checking keyfields
+- Start date is now set when pulling an experiment.
+- Supported Python version is now >= 3.9.
+- Changed row identification in ResultProcessor to experiment ID instead of checking keyfields.
 - Stack traces are now correctly logged into the mysql database, as the used mysql connector implementation has been changed to C. 
-- Changed multiprocessing to joblib due to issues with the example notebooks
+- Changed multiprocessing to joblib due to issues with the example notebooks.
 - The ``random_order`` parameter is not needed anymore for the execution, therefore it has been removed. 
 - Documentation of ``PyExperimenter.reset_experiments()`` has been updated to reflect the changes in the functionality.
 

docs/source/how-to-contribute.rst

@@ -17,7 +17,7 @@ At the end, please make sure that you also :ref:`extended the unit tests <contri
 Creating an Issue
 ------------------
 
-A GitHub issue should contain any information that is needed that a third person understands the problem (in case of a bug) or the vision of a new feature. To create an issue
+A GitHub issue should contain any information that is needed that a third person understands the problem (in case of a bug) or the vision of a new feature. To create an issue:
 
 1. Go to the `GitHub Issues <github_py_experimenter_issues_>`_.
 2. Summarize the bug / vision as title of the issue. 
@@ -182,9 +182,9 @@ The documentation of the ``PyExperimenter`` is key to all users to understand th
 Create Pull Request
 --------------------
 
-After all changes are made, including  :ref:`tests <contribute_unit_tests>` and :ref:`documentation <contribute_update_documentation>`, make sure to commit and :ref:`push <contribute_fork_project>` all your changes. 
+After all changes are made, including  :ref:`tests <contribute_unit_tests>` and :ref:`documentation <contribute_update_documentation>`, make sure to commit and :ref:`push <contribute_fork_project>` all your changes.
 
-Afterwards, go to the `PyExperimenter GitHub Pull Requests <github_py_experimenter_pulls_>`_ and create a new pull request. 
+Afterwards, go to the `PyExperimenter GitHub Pull Requests <github_py_experimenter_pulls_>`_ and create a new pull request.
 
 1. Make sure to select the correct source and destination repositories and according branches. The source repository is your fork, and the source branch is the ``<feature_branch_name>``. The destination repository is ``tornede/py_experimenter`` and the destination branch is ``develop``.
 

docs/source/usage/execution.rst

@@ -29,11 +29,11 @@ A ``PyExperimenter`` can be created without any further information, assuming th
 
 Additionally, further information can be given to ``PyExperimenter``:
 
-- ``experiment_configuration_file_path``: The path of the :ref:`experiment configuration file <experiment_configuration_file>`. Default: ``config/experiment_configuration.cfg``
+- ``experiment_configuration_file_path``: The path of the :ref:`experiment configuration file <experiment_configuration_file>`. Default: ``config/experiment_configuration.cfg``.
 - ``database_credential_file_path``: The path of the :ref:`database credential file <database_credential_file>`. Default: ``config/database_credentials.cfg``
 - ``database_name``: The name of the database to manage the experiments. If given, it will overwrite the database name given in the `experiment_configuration_file_path`.
 - ``table_name``: The name of the database table to manage the experiments. If given, it will overwrite the table name given in the `experiment_configuration_file_path`.
-- ``name``: The name of the experimenter, which will be added to the database table of each executed experiment. If using the PyExperimenter on an HPC system, this can be used for the job ID, so that the according log file can easily be found. Default: ``PyExperimenter``
+- ``name``: The name of the experimenter, which will be added to the database table of each executed experiment. If using the PyExperimenter on an HPC system, this can be used for the job ID, so that the according log file can easily be found. Default: ``PyExperimenter``.
 
 
 -------------------
@@ -118,7 +118,7 @@ The following status exist:
 
 - ``created``: All parameters for the experiment are defined and the experiment is ready for execution.
 - ``running``: The experiment is currently in execution.
-- ``done``: The execution of the experiment terminated without interruption and the results are written into the database
+- ``done``: The execution of the experiment terminated without interruption and the results are written into the database.
 - ``error``: An error occurred during execution, which is also logged into the database.
 
 

py_experimenter/utils.py

@@ -5,12 +5,12 @@
 
 import numpy as np
 
-from py_experimenter.exceptions import ConfigError, MissingLogTableError, NoConfigFileError, ParameterCombinationError
+from py_experimenter.exceptions import ConfigError, NoConfigFileError, ParameterCombinationError
 
 
 def load_config(path):
     """
-    Load and return configuration file
+    Load and return configuration file.
     :param path: path to the config file
     :return: configuration file
     """
@@ -50,7 +50,7 @@ def get_keyfield_data(config):
 def extract_db_credentials_and_table_name_from_config(config):
     """
     Initialize connection to database based on configuration file. If the tables does not exist, a new one will be
-    created automatically
+    created automatically.
     :param config: Configuration file with database and experiment information
     :return: mysql_connector and table name from the config file
     """