Apply suggestions from code review

Co-authored-by: Albert Y. Shih <[email protected]>
sunpy · Nov 13, 2024 · 1be344f · 1be344f
1 parent 5884fc6
commit 1be344f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/changelog/207.breaking.rst b/changelog/207.breaking.rst
@@ -1,7 +1,7 @@
 **New Coalignment API in sunkit_image.coalignment**
 
 The new coalignment API, developed as part of GSoC 2024, addresses the need for a more precise and flexible approach to image coalignment within the `sunkit_image.coalignment` module.
-As solar imaging data continues to grow in complexity, the existing coalignment methods from ``sunpy.image.coalignment`` and ``sunpy.physics.solar_rotation`` were found to be scattered and lacked a unified interface, leading to confusion and redundant code.
+As solar imaging data continues to grow in complexity, the existing coalignment functions from ``sunpy.image.coalignment`` and ``sunpy.physics.solar_rotation`` were found to be scattered and lacked a unified interface, leading to confusion and redundant code.
 
 **New Features:**
 

diff --git a/docs/how_to_guide/adding_a_coalignment_method.rst b/docs/how_to_guide/adding_a_coalignment_method.rst
@@ -12,7 +12,7 @@ If you want to register a new coalignment method that can be used by :func:`~sun
     from sunkit_image.coalignment.interface import AffineParams
 
     @register_coalignment_method("my_coalign")
-    def my_coalignment_method(input_array, template_array):
+    def my_coalignment_method(input_array, target_array):
         # Your coalignment code goes here
         # This should encompass calculating the shifts,
         # handling NaN values appropriately.

diff --git a/examples/aligning_aia_with_eis_maps.py b/examples/aligning_aia_with_eis_maps.py
@@ -19,7 +19,7 @@
 from sunkit_image.coalignment import coalign
 
 ###################################################################################
-# Firstly, let us acquire the IS and AIA data we need for this example.
+# Firstly, let us acquire the EIS and AIA data we need for this example.
 #
 # For this example, we will use the IS data from the sunpy data repository.
 # This is a preprocessed IS raster data.