[gnuastro-commits] master 8ff805a3 2/2: CosmicCalculator: --angluardimdist changed to --angulardiamdist

[Mohammad Akhlaghi]

branch: master
commit 8ff805a353992e540a057237adc598db32c28a77
Author: Boud Roukema <boud@cosmo.torun.pl>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    CosmicCalculator: --angluardimdist changed to --angulardiamdist
    
    Until now, the option for calculating the special case of the flat-space
    angular diameter distance, i.e. the radial comoving distance divided by
    (1+z), had the string "dim" (possibly alluding to "dimension"?)  rather
    than "diam" to indicate "diameter".
    
    With this commit, 'diam' is used instead of "dim" respectively to avoid
    this confusion. The 'NEWS' file now includes this as a "Changed feature"
    for people who may confront an error after updating to a new version.
---
 NEWS                      | 5 +++++
 bin/cosmiccal/args.h      | 4 ++--
 bin/cosmiccal/cosmiccal.c | 2 +-
 bin/cosmiccal/ui.h        | 2 +-
 doc/gnuastro.texi         | 2 +-
 5 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/NEWS b/NEWS
index 48c6d2ec..51bd0bbf 100644
--- a/NEWS
+++ b/NEWS
@@ -212,6 +212,11 @@ See the end of the file for license conditions.
     Sepideh Eskandarlou and implemented by Faezeh Bidjarchian after a poll
     on Gnuastro's Matrix chat channel (#gnuastro:openastronomy.org).
 
+*** CosmicCalculator
+  --angulardiamdist is the new name for the old '--angulardimdist'
+    option. This was necessary to avoid confusion of 'dim' in the old name
+    with "dimension"; 'diam' makes it clear that this is a "diameter", not
+    'dimension'.
 *** Crop
   - The 'ICF*' keywords are now written in the 0-th HDU of Crop's outputs
     (the extension with no data, only metadata). Therefore, the WCS is now
diff --git a/bin/cosmiccal/args.h b/bin/cosmiccal/args.h
index 4b775532..b032c0ab 100644
--- a/bin/cosmiccal/args.h
+++ b/bin/cosmiccal/args.h
@@ -191,8 +191,8 @@ struct argp_option program_options[] =
       ui_add_to_single_value,
     },
     {
-      "angulardimdist",
-      UI_KEY_ANGULARDIMDIST,
+      "angulardiamdist",
+      UI_KEY_ANGULARDIAMDIST,
       0,
       0,
       "Angular diameter distance (Mpc).",
diff --git a/bin/cosmiccal/cosmiccal.c b/bin/cosmiccal/cosmiccal.c
index a281903d..fcb531d6 100644
--- a/bin/cosmiccal/cosmiccal.c
+++ b/bin/cosmiccal/cosmiccal.c
@@ -194,7 +194,7 @@ cosmiccal(struct cosmiccalparams *p)
                                                           p->oradiation));
               break;
 
-            case UI_KEY_ANGULARDIMDIST:
+            case UI_KEY_ANGULARDIAMDIST:
               printf("%f", gal_cosmology_angular_distance(p->redshift, p->H0,
                                                            p->olambda,
                                                            p->omatter,
diff --git a/bin/cosmiccal/ui.h b/bin/cosmiccal/ui.h
index ba88705c..dc30c9f6 100644
--- a/bin/cosmiccal/ui.h
+++ b/bin/cosmiccal/ui.h
@@ -61,7 +61,7 @@ enum option_keys_enum
   UI_KEY_AGENOW              = 'G',
   UI_KEY_CRITICALDENSITYNOW  = 'C',
   UI_KEY_PROPERDISTANCE      = 'd',
-  UI_KEY_ANGULARDIMDIST      = 'A',
+  UI_KEY_ANGULARDIAMDIST     = 'A',
   UI_KEY_ARCSECTANDIST       = 's',
   UI_KEY_LUMINOSITYDIST      = 'L',
   UI_KEY_DISTANCEMODULUS     = 'u',
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 4221af53..1b12473b 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -33086,7 +33086,7 @@ The proper distance (at current time) to object at the 
given redshift in Megapar
 See @ref{Distance on a 2D curved space} for a description of the proper 
distance.
 
 @item -A
-@itemx --angulardimdist
+@itemx --angulardiamdist
 The angular diameter distance to object at given redshift in Megaparsecs (Mpc).
 
 @item -s