From 78b67d3ab6126d2efd4167cf4a747ca3f749fa1c Mon Sep 17 00:00:00 2001
From: Colin <cophus@gmail.com>
Date: Sat, 6 Jul 2024 08:51:47 -0700
Subject: [PATCH] updating docstring

---
 py4DSTEM/process/polar/polar_peaks.py | 56 ++++++++++++++++++---------
 1 file changed, 37 insertions(+), 19 deletions(-)

diff --git a/py4DSTEM/process/polar/polar_peaks.py b/py4DSTEM/process/polar/polar_peaks.py
index cbf29ba7d..7bc9637d7 100644
--- a/py4DSTEM/process/polar/polar_peaks.py
+++ b/py4DSTEM/process/polar/polar_peaks.py
@@ -1263,25 +1263,43 @@ def make_orientation_histogram(
     NOTE - currently assumes two fold rotation symmetry
     TODO - add support for non two fold symmetry polardatacube
 
-    Args:
-        radial_ranges (np array):           Size (N x 2) array for N radial bins, or (2,) for a single bin.
-        orientation_flip_sign (bool):       Flip the direction of theta
-        orientation_offset_degrees (float): Offset for orientation angles
-        orientation_separate_bins (bool):   whether to place multiple angles into multiple radial bins.
-        upsample_factor (float):            Upsample factor
-        use_refined_peaks (float):          Use refined peak positions
-        use_peak_sigma (float):             Spread signal along annular direction using measured std.
-        theta_step_deg (float):             Step size along annular direction in degrees
-        sigma_x (float):                    Smoothing in x direction before upsample
-        sigma_y (float):                    Smoothing in x direction before upsample
-        sigma_theta (float):                Smoothing in annular direction (units of bins, periodic)
-        normalize_intensity_image (bool):   Normalize to max peak intensity = 1, per image
-        normalize_intensity_stack (bool):   Normalize to max peak intensity = 1, all images
-        progress_bar (bool):                Enable progress bar
-
-    Returns:
-        orient_hist (array):                4D array containing Bragg peak intensity histogram
-                                            [radial_bin x_probe y_probe theta]
+    Parameters
+    ----------
+    radial_ranges (np array)          
+        Size (N x 2) array for N radial bins, or (2,) for a single bin.
+    orientation_flip_sign (bool)      
+        Flip the direction of theta
+    orientation_offset_degrees (float)
+        Offset for orientation angles.
+        This value is a rotation of Q space with respect to R space.
+    orientation_separate_bins (bool)
+        whether to place multiple angles into multiple radial bins.
+    upsample_factor (float)            
+        Upsample factor
+    use_refined_peaks (float)         
+        Use refined peak positions
+    use_peak_sigma (float)         
+        Spread signal along annular direction using measured std.
+    theta_step_deg (float)            
+        Step size along annular direction in degrees
+    sigma_x (float)                 
+        Smoothing in x direction before upsample
+    sigma_y (float)                   
+        Smoothing in x direction before upsample
+    sigma_theta (float)                
+        Smoothing in annular direction (units of bins, periodic)
+    normalize_intensity_image (bool)  
+        Normalize to max peak intensity = 1, per image
+    normalize_intensity_stack (bool)
+        Normalize to max peak intensity = 1, all images
+    progress_bar (bool)              
+        Enable progress bar
+
+    Returns
+    ----------
+    orient_hist (array)         
+        4D array containing Bragg peak intensity histogram
+        [radial_bin x_probe y_probe theta]
     """
 
     # coordinates