Merge pull request #1621 from danforthcenter/obj_size_ecdf-docs-bugfix

Obj size ecdf docs bugfix
danforthcenter · Nov 1, 2024 · e401fa3 · e401fa3
2 parents 23b9f1a + d5b9432
commit e401fa3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/docs/updating.md b/docs/updating.md
@@ -1334,6 +1334,12 @@ pages for more details on the input and output variable types.
 
 * pre v3.13: NA
 * post v3.13: fig_ecdf = **plantcv.visualize.obj_size_ecdf**(*mask, title=None*)
+* post v4.0: fig_ecdf = **plantcv.visualize.obj_size_ecdf**(*mask*)
+
+#### plantcv.visualize.obj_sizes
+
+* pre v3.13: NA
+* post v3.13: plotting_img = **pcv.visualize.obj_sizes**(*img, mask, num_objects=100*)
 
 #### plantcv.visualize.pseudocolor
 
@@ -1343,11 +1349,6 @@ pages for more details on the input and output variable types.
 * post v3.12: pseudo_img = **plantcv.visualize.pseudocolor**(*gray_img, obj=None, mask=None, cmap=None, background="image", min_value=0, max_value=255, axes=True, colorbar=True, obj_padding="auto", title=None*)
 * post v4.0: pseudo_img = **plantcv.visualize.pseudocolor**(*gray_img, mask=None, cmap=None, background="image", min_value=0, max_value=255, axes=True, colorbar=True, title=None*)
 
-#### plantcv.visualize.obj_sizes
-
-* pre v3.13: NA
-* post v3.13: plotting_img = **pcv.visualize.obj_sizes**(*img, mask, num_objects=100*)
-
 #### plantcv.visualize.pixel_scatter_plot
 
 * pre v4.0: NA

diff --git a/docs/visualize_obj_size_ecdf.md b/docs/visualize_obj_size_ecdf.md
@@ -3,12 +3,11 @@
 This is a visualization method used to examine the distribution of object sizes. It is an alternative to histogram 
 visualization.
 
-**plantcv.visualize.ecdf.obj_size**(*mask, title=None*)
+**plantcv.visualize.obj_size_ecdf**(*mask*)
 **returns** fig_ecdf
 
 - **Parameters:**
     - mask - Binary mask made from selected contours (default mask=None).
-    - title - The title for the ecdf plot (default title=None) 
 
 **Context:**
 - Examine the cumulative distribution of object sizes found in a binary mask. This can be used as an alternative 
@@ -26,7 +25,7 @@ visualization.
 ```python
 from plantcv import plantcv as pcv
 pcv.params.debug = "plot"
-fig_ecdf = pcv.visualize.ecdf.obj_size(mask=mask)
+fig_ecdf = pcv.visualize.obj_size_ecdf(mask=mask)
 ```
 
 **Cumulative distribution of object sizes**