Skip to content

doc: Add documentation reflecting new CLI#215

Merged
sbillinge merged 10 commits intodiffpy:mainfrom
cadenmyers13:doc0.3.0
Feb 27, 2026
Merged

doc: Add documentation reflecting new CLI#215
sbillinge merged 10 commits intodiffpy:mainfrom
cadenmyers13:doc0.3.0

Conversation

@cadenmyers13
Copy link
Contributor

closes #192

I also made it so that when a wavelength isnt specified and a wavelength cannot be found, it returns a value error instead of printing the message. This makes the behavior much cleaner and doesn't allow for things to slip pass

if use_gui or _running_in_gui():
os.environ["NO_COLOR"] = "1"
os.environ["CLICOLOR"] = "0"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need this because I think in the latest skpkg, the CLI prints in color and Gooey cannot handle this nicely, the ANSI sequence shows up in the panel.

@cadenmyers13
Copy link
Contributor Author

@sbillinge ready for review

@sbillinge sbillinge merged commit d016b99 into diffpy:main Feb 27, 2026
3 checks passed
@codecov
Copy link

codecov bot commented Feb 27, 2026

Codecov Report

❌ Patch coverage is 95.65217% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 99.13%. Comparing base (6a632b7) to head (be60e61).
⚠️ Report is 11 commits behind head on main.

Files with missing lines Patch % Lines
tests/test_tools.py 95.65% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #215      +/-   ##
==========================================
- Coverage   99.37%   99.13%   -0.25%     
==========================================
  Files           5        5              
  Lines         322      345      +23     
==========================================
+ Hits          320      342      +22     
- Misses          2        3       +1     
Files with missing lines Coverage Δ
tests/test_tools.py 98.67% <95.65%> (-0.35%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cadenmyers13 cadenmyers13 deleted the doc0.3.0 branch February 27, 2026 20:58
@cadenmyers13 cadenmyers13 mentioned this pull request Feb 27, 2026
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.

docs: update documentation to reflect changes in the CLI structure and mud computation

2 participants