Skip to content

docs: for main module and also serves as a quick-start tutorial #177

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 2 commits into from
Apr 28, 2025

Conversation

yucongalicechen
Copy link
Collaborator

@yucongalicechen yucongalicechen commented Apr 28, 2025

closes #159, closes #148, closes #132, closes #114
@sbillinge ready for review.
I added a getting start tutorial and made some edits to the updates on functions and tools docs.

# Set and view the computed mu*D value
args = set_mud(args)
print(args.mud)

Note that only one method should be used at a time. The following are invalid examples:
Copy link
Collaborator Author

@yucongalicechen yucongalicechen Apr 28, 2025

Choose a reason for hiding this comment

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

moved this part to the example in labpdfprocapp

Copy link

codecov bot commented Apr 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.31%. Comparing base (89de7c2) to head (e222d5a).
Report is 13 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #177   +/-   ##
=======================================
  Coverage   99.31%   99.31%           
=======================================
  Files           5        5           
  Lines         292      292           
=======================================
  Hits          290      290           
  Misses          2        2           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge sbillinge merged commit 53ee55d into diffpy:main Apr 28, 2025
5 checks passed
@sbillinge
Copy link
Contributor

I merged. It is easier to test documentation by trying to use the built docs to actually do something.....

@yucongalicechen yucongalicechen deleted the docs-main branch May 1, 2025 15:42
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