From 597b38ca36e8b04c026a8c7ad205c533fca1f059 Mon Sep 17 00:00:00 2001 From: wreise Date: Wed, 7 Oct 2020 15:21:24 +0200 Subject: [PATCH] Fix code formatting/naming in the docstrings --- doc/modules/homology.rst | 6 ++++++ gtda/diagrams/features.py | 2 +- gtda/diagrams/preprocessing.py | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/modules/homology.rst b/doc/modules/homology.rst index f6ba5db68..e0795b02f 100644 --- 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 index 7ce885a56..a0576cbba 100644 --- 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 index a036ea2bd..1f1d0464e 100644 --- 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)