Skip to content

Update documentation#93

Merged
MatthewFilipovich merged 3 commits into
mainfrom
fix/docs
Apr 1, 2026
Merged

Update documentation#93
MatthewFilipovich merged 3 commits into
mainfrom
fix/docs

Conversation

@MatthewFilipovich

Copy link
Copy Markdown
Owner

Update 4f examples with smaller shape, and other minor changes.

Copilot AI review requested due to automatic review settings April 1, 2026 13:40
@codecov

codecov Bot commented Apr 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.92%. Comparing base (f2472b1) to head (974c4c8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #93   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          38       38           
  Lines        1305     1305           
=======================================
  Hits         1304     1304           
  Misses          1        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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates documentation and example scripts to use smaller default grid sizes for faster execution/rendering, while clarifying a few theoretical descriptions (LG mode notation, Gaussian Schell-model normalization, and inner-product definition).

Changes:

  • Reduce grid shape and adjust related physical parameters (focal length, tile length, filter radius, propagation distances) in README, quickstart, and the 4f example.
  • Clarify documentation math/notation: Laguerre–Gaussian mode superscript sign, normalized Gaussian intensity for the Gaussian Schell-model, and explicit Field.inner convention in the user guide.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
README.md Shrinks the 4f example parameters to a smaller grid and consistent physical scales.
examples/optimization/training_petal_beam.py Clarifies LG mode notation in the narrative comment.
examples/optical_systems/4f_system.py Uses smaller grid/physical parameters; updates plane count wording to match the 0…4f planes.
docs/source/user-guide/spatial_coherence.rst Documents the normalized Gaussian intensity used by gaussian_schell_model.
docs/source/user-guide/propagation.rst Refines the description of the critical-distance geometry term.
docs/source/user-guide/fields.rst Aligns the inner-product equation/notation with the library’s Field.inner convention.
docs/source/quickstart/index.rst Updates quickstart plots/examples to smaller grids and adjusted distances/parameters.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/source/user-guide/propagation.rst Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MatthewFilipovich MatthewFilipovich merged commit 4a0205c into main Apr 1, 2026
4 checks passed
@MatthewFilipovich MatthewFilipovich deleted the fix/docs branch April 1, 2026 13:48
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.

2 participants