add docs for `check_and_build_global_config()` by yucongalicechen · Pull Request #270 · diffpy/diffpy.utils

yucongalicechen · 2024-12-23T15:24:19Z

closes#268
@sbillinge ready for review

codecov · 2024-12-23T15:26:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.68%. Comparing base (d791c63) to head (13742d0).
Report is 10 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #270 +/- ##
=======================================
Coverage 98.68% 98.68% =======================================
Files 8 8 Lines 379 379 =======================================
Hits 374 374 Misses 5 5

yucongalicechen · 2024-12-23T15:27:17Z

-
-
-def stringify(obj):
+def _stringify(obj):


make this function private and remove unncessary functions

sbillinge

beautifully done. Just a couple of suggestions in line

sbillinge · 2024-12-23T17:24:53Z

+ Please enter your orcid ID if you know it: 0000-0000-0000-0000
+
+
+After receiving the inputs, the function will write the following to the file:


Maybe ".... the diffpyconfig.json file in the users home directory"?
On the one hand it is a bit repetitive (also did elsewhere), but maybe it is better to be clear?

sbillinge · 2024-12-23T17:27:48Z


+- ``check_and_build_global_config()``: This function helps create a global configuration file
+ that can be used by ``get_user_info()``.
+ If no existing configuration file is found, and the user allows inputs, this function prompts for information.


I think "user allows inputs" is confusing so I recommend to delete that.

yucongalicechen · 2024-12-23T20:13:58Z

@sbillinge ready for review!

yucongalicechen added 4 commits December 22, 2024 20:27

fix typo and add examples
77314a1

fix typos
ddf7180

remove unnecessary function
c29053d

no news added
cc8cf05