Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@ehpor
Copy link
Owner

@ehpor ehpor commented Jun 9, 2025

For the CZT, the docstring contained LaTeX which uses /s which are not escaped without using a raw string.

For the SHWFS tutorial, we used progressbar2 which led to characters in the resulting .rst file that were not correct ReST formatting. We changed to tqdm which does this correctly.

@ehpor ehpor self-assigned this Jun 9, 2025
@ehpor ehpor added documentation Missing or addition to documentation bugfix labels Jun 9, 2025
@ehpor ehpor requested a review from syhaffert June 9, 2025 17:48
@codecov
Copy link

codecov bot commented Jun 9, 2025

Codecov Report

Attention: Patch coverage is 57.14286% with 3 lines in your changes missing coverage. Please review.

Project coverage is 83.19%. Comparing base (b82d442) to head (529875c).
Report is 5 commits behind head on master.

Files with missing lines Patch % Lines
hcipy/plotting/animation.py 57.14% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #266      +/-   ##
==========================================
+ Coverage   83.18%   83.19%   +0.01%     
==========================================
  Files         104      104              
  Lines        7779     7779              
==========================================
+ Hits         6471     6472       +1     
+ Misses       1308     1307       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ehpor ehpor changed the title Fix the docstring for CZT. Fix misc docs issues. Jun 9, 2025
@ehpor ehpor enabled auto-merge June 9, 2025 21:33
Copy link
Collaborator

@syhaffert syhaffert left a comment

Choose a reason for hiding this comment

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

looks good. ready to merge.

@ehpor ehpor merged commit b12e5d8 into master Jul 1, 2025
16 checks passed
@ehpor ehpor deleted the docs/czt_fix branch July 7, 2025 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix documentation Missing or addition to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants