Skip to content
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

Add instructions/link to fix missing user info issue in get_user_info function in tools.py #129

Closed
yucongalicechen opened this issue Oct 24, 2024 · 2 comments · Fixed by #149

Comments

@yucongalicechen
Copy link
Contributor

yucongalicechen commented Oct 24, 2024

Problem

Instructions for getting user info can be clearer. Right now there are no instructions in the warning message on how to fix missing user info.

Proposed solution

Edit messages in get_user_info function in tools.py. Specifically, include instructions in the warning message and/or include a link to the right place in the online docs for fixing missing user info issue.
For more details, see discussions in diffpy/diffpy.labpdfproc#113.

@sbillinge
Copy link
Contributor

further to this...the current behavior is good (warning but not error if name is missing). The problem is that there are no instructions in the warning how to fix the issue. There are instructions in diffpy.utils documentation, but we ran into the problem that this warning popped up when diffpy.labpdfproc was being run, and there is no way that the user would know to look in the online docs for diffpy.utils.....

fix: include instructions in the warning message itself (if they are short enough) and/or include a link to the right place in the online docs for how to fix it.

@yucongalicechen yucongalicechen changed the title Edit get_user_info function in tools.py Add instructions/link to fix missing user info issue in get_user_info function in tools.py Oct 24, 2024
@yucongalicechen
Copy link
Contributor Author

Got it! Updated the issue

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