update readme and some comments.

STOmics · Oct 20, 2023 · e2411fa · e2411fa
1 parent d0dcb08
commit e2411fa
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 [Documentation](https://stereopy.readthedocs.io/en/latest/index.html) - 
 [API](https://stereopy.readthedocs.io/en/latest/content/03_API.html)
 
-<img src="https://github.com/STOmics/stereopy/blob/main/docs/source/_static/Stereopy_workflow_v0.11.0.png" width="60%" height="80%">
+<img src="https://github.com/STOmics/stereopy/blob/main/docs/source/_static/Stereopy_workflow_v0.14.0.png" width="60%" height="80%">
 
 [comment]: <> (![Stereopy]&#40;./docs/source/_static/stereopy.PNG&#41;)
 

diff --git a/stereo/algorithm/community_detection.py b/stereo/algorithm/community_detection.py
@@ -719,7 +719,9 @@ def main(self, **kwargs):
 
         The window size and sliding step are optional CCD parameters. If not provided, the optimal window size is calculated throughout the iterative process with goal of having average number of cell-spots in all windows in range [30, 50]. Sliding step is set to the half of the window size.
 
-        Note: All the parameters are key word arguments.
+        .. note::
+
+            All the parameters are key word arguments.
 
         :param annotation: The key specified the cell type in obs.
         :param tfile: File path to Anndata object with calculated cell mixtures for data windows, output of calc_feature_matrix.