Testing doc formatting again

connorourke · Aug 6, 2018 · 325fecb · 325fecb
1 parent 18c78c8
commit 325fecb
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/crystal_torture/pymatgen_interface.py b/crystal_torture/pymatgen_interface.py
@@ -15,10 +15,13 @@
 
 def map_index(uc_neighbours, uc_index, x_d, y_d, z_d):
     """
-
+    =========
+    map_index
+    =========
     Takes a list of neighbour indices for sites in the original unit cell, 
     and maps them on to all of the supercell sites.
    
+    ----------
     Parameters
     ----------
 
@@ -30,7 +33,7 @@ def map_index(uc_neighbours, uc_index, x_d, y_d, z_d):
     y_d (int): y dimension of supercell
     z_d (int): z dimension of supercell
 
-
+    -------
     Returns
     -------