Skip to content

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

Merged
sbillinge merged 2 commits into
diffpy:mainfrom
yucongalicechen:docs-main
Apr 28, 2025
Merged

docs: for main module and also serves as a quick-start tutorial#177
sbillinge merged 2 commits into
diffpy:mainfrom
yucongalicechen:docs-main

Conversation

@yucongalicechen

@yucongalicechenyucongalicechen commented Apr 28, 2025

Copy link
Copy Markdown
Collaborator

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.

args = set_mud(args)
print(args.mud)

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

@yucongalicechenyucongalicechenApr 28, 2025

Copy link
Copy Markdown
CollaboratorAuthor

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

@codecov

codecovBot commented Apr 28, 2025

Copy link
Copy Markdown

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:mainApr 28, 2025
@sbillinge

Copy link
Copy Markdown
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants

@yucongalicechen@sbillinge