Merge pull request #55 from dpeerlab/fix_docs

Fix typos and update docstrings in ENVI.py
dpeerlab · Apr 30, 2024 · 5098dad · 5098dad
2 parents 4420a54 + daab959
commit 5098dad
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/scenvi/ENVI.py b/scenvi/ENVI.py
@@ -631,7 +631,7 @@ def impute_genes(self):
         """
         Impute full transcriptome for spatial data
 
-        :return: nothing adds 'imputation' to self.spatial_data.obsm
+        :return: nothing, adds 'imputation' to self.spatial_data.obsm
         """
 
         self.spatial_data.obsm["imputation"] = pd.DataFrame(
@@ -648,7 +648,7 @@ def infer_niche_covet(self):
         """
         Predict COVET representation for single-cell data
 
-        :return: nothing adds 'COVET_SQRT' and 'COVET' to self.spatial_data.obsm
+        :return: nothing, adds 'COVET_SQRT' and 'COVET' to self.spatial_data.obsm
         """
 
         self.sc_data.obsm["COVET_SQRT"] = self.decode_cov(
@@ -662,7 +662,7 @@ def infer_niche_celltype(self, cell_type_key="cell_type"):
         """
         Predict cell type abundence based one ENVI-inferred COVET representations
 
-        :param cell_type_key (string): key in spatial_data.obs where cell types are stored for environment composition (default 'cell_type')
+        :param cell_type_key: (string) key in spatial_data.obs where cell types are stored for environment composition (default 'cell_type')
 
         :return: nothing, adds 'niche_cell_type' to self.sc_data.obsm & self.spatial_data.obsm
         """