Closed
Conversation
Owner
ardiloot
commented
Feb 20, 2026
ardiloot
commented
- Modernize README.md: add pre-commit badge, installation section, quick code example, development section, license
- Fix Introduction.rst: complete publication Configure Renovate #2 reference (was 'TPB'), fix typos, update technical features for ARM support
- Fix GettingStarted.rst: update Python requirement to >=3.10, fix ~15 typos throughout, replace placeholder nonlinear TMM examples with actual code
- Modernize README.md: add pre-commit badge, installation section, quick example, development section, fix typos - Fix Introduction.rst: complete publication #2 reference (was 'TPB'), fix typos, update technical features for ARM support - Fix GettingStarted.rst: update Python requirement to >=3.10, fix typos throughout, add second-order nonlinear TMM example
- Update copyright year to 2026 in conf.py - Fix Texinfo placeholder description in conf.py - Fix grammar and phrasing throughout GettingStarted.rst - Fix 'physics are' -> 'physics is' in README.md
- 'physics are' → 'physics is' in Introduction.rst - 'is named Kretschmann configuration' → 'is known as the Kretschmann configuration' in GettingStarted.rst - Remove unnecessary article in 'both the plane waves and beams' in GettingStarted.rst
Inspired by GeneralTmm README structure: - Add Python version and License badges - Add hero image (Gaussian beam SPP excitation) - Add 'See also' callout linking to GeneralTmm - Add full Table of Contents - Bold feature names with descriptions - Add API Overview table (Material, TMM, SecondOrderNLTMM) - Restructure examples with images (SPP, Gaussian beam, SHG) - Add References section with blockquoted citations - Expand Development section with subsections (Setup, Tests, Linting, CI table) - Add Releasing section with setuptools-scm workflow - Link License to LICENSE file
- Add setup schematic, SHG intensity, and thickness dependence panels to ExampleSecondOrderNonlinearTmm.py - Add savefig to all three example scripts - Add SHG example image and description to GettingStarted.rst - Remove non-existent Material.FromFile from API table - Fix Python version range: 3.10-3.14 (matches CI matrix) - Fix CI table: show full Python version range - Fix grammar: 'Same' → 'The same', add articles, add commas - Use 'uv run pre-commit install' instead of 'uvx'
ardiloot
added a commit
that referenced
this pull request
Feb 20, 2026
- Overhaul README with badges, hero image, TOC, API table, examples with images, references, development/releasing sections, and CI overview - Add 'See also' cross-reference to GeneralTmm - Improve SHG example with setup schematic, intensity, and thickness panels - Add savefig to all three example scripts and generate SHG image - Fix typos and grammar across Introduction.rst and GettingStarted.rst - Replace nonlinear TMM placeholder with literalinclude and image - Update copyright year, Texinfo description, Python version to >=3.10 - Fix publication #2 citation (was truncated 'TPB')
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.