Skip to content

More info on updating global config for users #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 8, 2024

Conversation

alisnwu
Copy link

@alisnwu alisnwu commented Dec 7, 2024

closes #156

Screenshot 2024-12-07 at 5 52 42 PM

@sbillinge ready for review, new message points to where users can update manually and examples on the diffpy.utils link

Copy link

codecov bot commented Dec 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.54%. Comparing base (d8d7fb3) to head (74a740a).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #208      +/-   ##
==========================================
+ Coverage   96.49%   96.54%   +0.05%     
==========================================
  Files           8        8              
  Lines         342      347       +5     
==========================================
+ Hits          330      335       +5     
  Misses         12       12              

see 1 file with indirect coverage changes

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please see inline. news needs fixing but otherwise this is great

@@ -0,0 +1,23 @@
**Added:**

* additional information to users to relieve frustration in finding how to update global config
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no functionality added. Move this to Fixed

@alisnwu
Copy link
Author

alisnwu commented Dec 8, 2024

@sbillinge fixed news item, ready for review

@sbillinge sbillinge merged commit 77c0b9e into diffpy:main Dec 8, 2024
5 checks passed
@sbillinge
Copy link
Contributor

btw @alisnwu I closed this before reading https://www.diffpy.org/diffpy.utils/examples/toolsexample.html but there I saw no clear information about how to update the default user information. I would put it as an enumerated list to make it clearer. there are at least 4 different ways of setting these things with more or less permanence. Make it as an enumerated list. But also discuss with and example how to updage your default file using a text editor.

Also, is this a typo?

from diffpy.utils.tools import get_user_info
package_metadata = get_package_info("my_package")

@sbillinge
Copy link
Contributor

moved this comment to issue #210

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New workflow for users to update the global config file
2 participants