docs: small typos

insilichem · Apr 18, 2017 · 1d16384 · 1d16384
1 parent 86e94d6
commit 1d16384
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -43,7 +43,7 @@ Features
 Documentation and support
 -------------------------
 
-Documentation source is available in ``docs/`` subdirectory, and also compiled as HTML at `this webpage <http://gaudi.readthedocs.io/>`_
+Documentation source is available in ``docs/`` subdirectory, and also compiled as HTML at `this webpage <http://gaudi.readthedocs.io/>`_.
 
 If you need help with GaudiMM, please use the `issues page <https://github.com/insilichem/gaudi/issues>`_ of our `GitHub repo <https://github.com/insilichem/gaudi>`_. You can drop me a message at `jaime.rodriguezguerra@uab.cat <mailto:jaime.rodriguezguerra@uab.cat>`_ too.
 

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -64,4 +64,4 @@ What is the difference between ``atom_names`` and ``atom_types`` in some objecti
 
 .. tip::
 
-   Any further questions? Feel free to submit your inquiries to our issues page!
+   Any further questions? Feel free to submit your inquiries to our `issues page <https://github.com/insilichem/gaudi/issues>`_!
diff --git a/gaudi/__init__.py b/gaudi/__init__.py
@@ -29,13 +29,13 @@
 The main module is :mod:`gaudi.base`, which defines the :class:`gaudi.base.Individual`,
 whose instances represent the potential solutions to the proposed problem. Two plugin
 packages allow easy customization of how individuals are defined (:mod:`gaudi.genes`) and
-how they are evaluated (:mod:`gaudi.objectives`).
+how they are evaluated (:mod:`gaudi.objectives`). Additionally:
 
-:mod:`gaudi.parse` contains parsing utilities to retrieve the configuration files.
-
-:mod:`gaudi.plugin` holds some magic to make the plugin system work.
-
-:mod:`gaudi.box` is a placeholder for several small functions that are used across GAUDI.
+- :mod:`gaudi.algorithms` is the place to look for the actual GA implementation
+- :mod:`gaudi.box` is a placeholder for several small functions that are used across GaudiMM.
+- :mod:`gaudi.parse` contains parsing utilities to retrieve the configuration files.
+- :mod:`gaudi.plugin` holds some magic to make the plugin system work.
+- :mod:`gaudi.similarity` defines the diversity enhancers.
 """
 
 # Logging