Improve documentation and error handling Mixture node
#446
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #446 +/- ##
=======================================
Coverage 73.59% 73.59%
=======================================
Files 195 195
Lines 5593 5594 +1
=======================================
+ Hits 4116 4117 +1
Misses 1477 1477 ☔ View full report in Codecov by Sentry. |
Nimrais
reviewed
Feb 3, 2025
bvdmitri
reviewed
Feb 4, 2025
Co-authored-by: Bagaev Dmitry <[email protected]>
bvdmitri
approved these changes
Feb 4, 2025
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.
This pull request includes minor changes to the
src/addons/logscale.jlandsrc/nodes/predefined/mixture.jlfiles to enhance error messaging and documentation. The most important changes include adding a more detailed error message for missing log-scale addons and providing comprehensive documentation for theMixtureNodestruct.Enhancements to error messaging:
src/addons/logscale.jl: Added a detailed error message for cases where the log-scale addon is not available, guiding users to includeAddonLogScalein the addons.Improvements to documentation:
src/nodes/predefined/mixture.jl: Added extensive documentation for theMixtureNode{N}struct, including a description of its interfaces, an example usage, and a note on the requirement of theAddonLogScaleaddon.