Skip to content

Developer API Docs#35

Merged
StackEnjoyer merged 45 commits intomasterfrom
Developer-API-docs
Sep 14, 2025
Merged

Developer API Docs#35
StackEnjoyer merged 45 commits intomasterfrom
Developer-API-docs

Conversation

@StackEnjoyer
Copy link
Collaborator

@StackEnjoyer StackEnjoyer commented Sep 12, 2025

Addresses issue #32 and #33. Primarily, an API design section has been added for users that want to build on the current functionality of BMO. The overall sectioning has been reworked, components now fall under the Basics section. Some figures have been overhauled. In addition, the conditional_include script reduces local buildtime by replacing render scripts with placeholder images.

The version remain v0.10.2.

ToDo

  • test conditional_include in CI environment
  • disable push_preview before merging
  • check docs

= and others added 30 commits September 3, 2025 17:30
…n and merging the Optical elements section with the Components section
…n and merging the Optical elements section with the Components section
@codecov
Copy link

codecov bot commented Sep 12, 2025

Codecov Report

❌ Patch coverage is 61.53846% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.66%. Comparing base (0a9b281) to head (f431821).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
ext/RenderPresets.jl 0.00% 2 Missing ⚠️
ext/RenderLenses.jl 0.00% 1 Missing ⚠️
src/OpticalComponents/Intersectable.jl 50.00% 1 Missing ⚠️
src/PolarizedRays.jl 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #35      +/-   ##
==========================================
+ Coverage   71.46%   71.66%   +0.20%     
==========================================
  Files          57       57              
  Lines        2793     2792       -1     
==========================================
+ Hits         1996     2001       +5     
+ Misses        797      791       -6     

☔ 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.

@StackEnjoyer StackEnjoyer marked this pull request as ready for review September 12, 2025 12:59
@StackEnjoyer StackEnjoyer self-assigned this Sep 12, 2025
@StackEnjoyer StackEnjoyer added the documentation Improvements or additions to documentation label Sep 12, 2025
@StackEnjoyer
Copy link
Collaborator Author

@TacHawkes die codecov CI meckert rum wegen einer Zeile, bitte review und dann force ich den merge

@StackEnjoyer StackEnjoyer merged commit 7a0ab61 into master Sep 14, 2025
5 of 6 checks passed
@StackEnjoyer StackEnjoyer deleted the Developer-API-docs branch September 14, 2025 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant