adding additional documentation to the code

proost · Dec 1, 2017 · 6f57cda · 6f57cda
1 parent 2500f22
commit 6f57cda
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 5 deletions.
diff --git a/conekt/models/gene_families.py b/conekt/models/gene_families.py
@@ -294,11 +294,10 @@ def family_stats(self):
     @staticmethod
     def __add_families(families, family_members):
         """
-        Adds gene families to the database and assigs genes to their designated family
+        Adds gene families to the database and assigns genes to their designated family
 
-        :param families:
-        :param family_members:
-        :return:
+        :param families: list of GeneFamily objects
+        :param family_members: dict (keys = gene family name) with lists of members
         """
         for i, f in enumerate(families):
             db.session.add(f)

diff --git a/docs/tutorials/001_basics.md b/docs/tutorials/001_basics.md
@@ -1,8 +1,20 @@
 # Tutorial: The basics
 
-## Home page and Menu
+## Home page and Species page
 
+![overview](images/overview.png "Conekt Overview")
 
+On the CoNekT you quickly can get updated about announcements (e.g. server downtime), recent changes and general 
+updates from the lab's twitter feed. 
+
+To check out which **species** are currently included in CoNekT, a species page can be accessed through the **menu button** 
+named **Species** on the top of the page. This will bring up a page with the species tree and a table with species included
+along with some general statistics.
+
+![species](images/species.png "Species")
+
+Note the buttons to **download** all gene **sequences** and the complete co-expression **networks**. Click on a species
+name to bring up a brief description and other relevant information (e.g. useful links, ... )
 
 ## Search
 
diff --git a/docs/tutorials/images/overview.png b/docs/tutorials/images/overview.png
diff --git a/docs/tutorials/images/species.png b/docs/tutorials/images/species.png