docs: add missing docstrings for ThermalEmission + StreamRTResult#223
Open
cfranken wants to merge 1 commit into
Open
docs: add missing docstrings for ThermalEmission + StreamRTResult#223cfranken wants to merge 1 commit into
cfranken wants to merge 1 commit into
Conversation
…run_streams Documenter's :missing_docs check fails because 7 docstrings (StreamRTResult, rt_run_streams, ThermalEmission, PreparedThermalEmission, contribute!, prepare_source for ThermalEmission) were exported but not referenced in any @docs block. Add them to the CoreRT API page and the sources extension page.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the documentation CI failure caused by Documenter’s :missing_docs check by adding the missing public API docstring references introduced with the v0.7 ThermalEmission source and StreamRTResult stream-level output.
Changes:
- Adds
ThermalEmission/PreparedThermalEmissionand their key dispatch entry points (prepare_source,contribute!) to the sources extension@docsblocks. - Adds a new “Stream-Level RT Output” section to the CoreRT API page documenting
StreamRTResultandrt_run_streams.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/src/pages/extending/sources.md | Extends the source-term API reference to include ThermalEmission-related docstrings and entry points. |
| docs/src/pages/api/core_rt.md | Documents stream-level RT outputs by adding StreamRTResult and rt_run_streams to the CoreRT API page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
:missing_docscheck@docsblocks in the CoreRT API page and the sources extension pageTest plan