From ef7f955e1e90c4d22582d2a65faff3ed22a88008 Mon Sep 17 00:00:00 2001
From: Jacob Boerema <jgboerema@gmail.com>
Date: Sun, 9 Apr 2023 21:31:51 -0400
Subject: [PATCH] pdb, libgimp: improve function documentation for sample
 points

- gimp_image_add_sample_point: guide is a left-over from copy-pasting and
add apostrophe
- gimp_image_get_sample_point_position: it was not clear that the
parameter was the y-offset and the return value the x-offset
---
 app/pdb/image-sample-points-cmds.c  | 8 ++++----
 libgimp/gimpimagesamplepoints_pdb.c | 8 ++++----
 pdb/groups/image_sample_points.pdb  | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/app/pdb/image-sample-points-cmds.c b/app/pdb/image-sample-points-cmds.c
index 51c0fbdf22..6c9b2d5195 100644
--- a/app/pdb/image-sample-points-cmds.c
+++ b/app/pdb/image-sample-points-cmds.c
@@ -227,13 +227,13 @@ register_image_sample_points_procs (GimpPDB *pdb)
   gimp_procedure_add_argument (procedure,
                                g_param_spec_int ("position-x",
                                                  "position x",
-                                                 "The guide'sample points x-offset from left of image",
+                                                 "The sample point's x-offset from left of image",
                                                  0, G_MAXINT32, 0,
                                                  GIMP_PARAM_READWRITE));
   gimp_procedure_add_argument (procedure,
                                g_param_spec_int ("position-y",
                                                  "position y",
-                                                 "The guide'sample points y-offset from top of image",
+                                                 "The sample point's y-offset from top of image",
                                                  0, G_MAXINT32, 0,
                                                  GIMP_PARAM_READWRITE));
   gimp_procedure_add_return_value (procedure,
@@ -338,13 +338,13 @@ register_image_sample_points_procs (GimpPDB *pdb)
   gimp_procedure_add_return_value (procedure,
                                    g_param_spec_int ("position-x",
                                                      "position x",
-                                                     "The sample points's position relative to top of image",
+                                                     "The sample point's x-offset relative to left of image",
                                                      G_MININT32, G_MAXINT32, 0,
                                                      GIMP_PARAM_READWRITE));
   gimp_procedure_add_return_value (procedure,
                                    g_param_spec_int ("position-y",
                                                      "position y",
-                                                     "The sample points's position relative to top of image",
+                                                     "The sample point's y-offset relative to top of image",
                                                      G_MININT32, G_MAXINT32, 0,
                                                      GIMP_PARAM_READWRITE));
   gimp_pdb_register_procedure (pdb, procedure);
diff --git a/libgimp/gimpimagesamplepoints_pdb.c b/libgimp/gimpimagesamplepoints_pdb.c
index fc01324c3c..b529c62d97 100644
--- a/libgimp/gimpimagesamplepoints_pdb.c
+++ b/libgimp/gimpimagesamplepoints_pdb.c
@@ -39,8 +39,8 @@
 /**
  * gimp_image_add_sample_point:
  * @image: The image.
- * @position_x: The guide'sample points x-offset from left of image.
- * @position_y: The guide'sample points y-offset from top of image.
+ * @position_x: The sample point's x-offset from left of image.
+ * @position_y: The sample point's y-offset from top of image.
  *
  * Add a sample point to an image.
  *
@@ -167,7 +167,7 @@ gimp_image_find_next_sample_point (GimpImage *image,
  * gimp_image_get_sample_point_position:
  * @image: The image.
  * @sample_point: The guide.
- * @position_y: (out): The sample points's position relative to top of image.
+ * @position_y: (out): The sample point's y-offset relative to top of image.
  *
  * Get position of a sample point on an image.
  *
@@ -175,7 +175,7 @@ gimp_image_find_next_sample_point (GimpImage *image,
  * returns the position of the sample point relative to the top and
  * left of the image.
  *
- * Returns: The sample points's position relative to top of image.
+ * Returns: The sample point's x-offset relative to left of image.
  *
  * Since: 2.10
  **/
diff --git a/pdb/groups/image_sample_points.pdb b/pdb/groups/image_sample_points.pdb
index 8a051034d3..21fce3eee4 100644
--- a/pdb/groups/image_sample_points.pdb
+++ b/pdb/groups/image_sample_points.pdb
@@ -31,9 +31,9 @@ HELP
 	{ name => 'image', type => 'image',
 	  desc => 'The image' },
 	{ name => 'position_x', type => '0 <= int32',
-	  desc => "The guide'sample points x-offset from left of image" },
+	  desc => "The sample point's x-offset from left of image" },
 	{ name => 'position_y', type => '0 <= int32',
-	  desc => "The guide'sample points y-offset from top of image" }
+	  desc => "The sample point's y-offset from top of image" }
     );
 
     @outargs = (
@@ -159,10 +159,10 @@ HELP
     @outargs = (
 	{ name => 'position_x', type => 'int32',
           libdef => 'G_MININT',
-	  desc => "The sample points's position relative to top of image" },
+	  desc => "The sample point's x-offset relative to left of image" },
 	{ name => 'position_y', type => 'int32',
           libdef => 'G_MININT',
-	  desc => "The sample points's position relative to top of image" }
+	  desc => "The sample point's y-offset relative to top of image" }
     );
 
     %invoke = (