Fix code formatting/naming in the docstrings

giotto-ai · Oct 7, 2020 · 597b38c · ulupo · Oct 7, 2020 · ulupo
1 parent d4fc997
commit 597b38c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/doc/modules/homology.rst b/doc/modules/homology.rst
@@ -20,6 +20,12 @@ Undirected simplicial homology
 
 Directed simplicial homology
 ----------------------------
+.. currentmodule:: gtda
+
+.. autosummary::
+   :toctree: generated/homology/
+   :template: class.rst
+
    homology.FlagserPersistence
 
 Cubical homology

diff --git a/gtda/diagrams/features.py b/gtda/diagrams/features.py
@@ -697,7 +697,7 @@ def transform(self, X, y=None):
         Returns
         -------
         Xt : ndarray of shape (n_samples, n_homology_dimensions * 2 \
-            * n_coefficients_)
+            * n_coefficients)
             Polynomial coefficients: real and imaginary parts of the complex
             polynomials obtained in each homology dimension from each diagram
             in `X`.

diff --git a/gtda/diagrams/preprocessing.py b/gtda/diagrams/preprocessing.py
@@ -471,7 +471,7 @@ def transform(self, X, y=None):
         Xt : ndarray of shape (n_samples, n_features_filtered, 3)
             Filtered persistence diagrams. Only the subdiagrams corresponding
             to dimensions in :attr:`homology_dimensions_` are filtered.
-            ``n_features_filtered`` is less than or equal to ``n_features`.
+            ``n_features_filtered`` is less than or equal to ``n_features``.
 
         """
         check_is_fitted(self)