Params Doc for Rules & OrbiterMeta#103
Merged
fritz-astronomer merged 5 commits intomainfrom Nov 6, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a params_doc parameter to rules and the OrbiterMeta class, allowing rules to include documentation for parameters they consume and emit. This enhances the metadata tracking capabilities of the rule system.
- Adds
params_docparameter to the@ruledecorator andRuleclass - Updates
OrbiterMetato includematched_rule_params_docfield - Updates doctest examples to reflect the new field in
OrbiterMetaoutput
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| orbiter/rules/init.py | Adds params_doc parameter to rule decorator and Rule class; updates doctest to show new OrbiterMeta field |
| orbiter/meta.py | Adds matched_rule_params_doc field to OrbiterMeta class with appropriate description |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #103 +/- ##
==========================================
+ Coverage 78.92% 82.26% +3.34%
==========================================
Files 35 51 +16
Lines 1362 1878 +516
==========================================
+ Hits 1075 1545 +470
- Misses 287 333 +46 ☔ View full report in Codecov by Sentry. |
8376664 to
920bd62
Compare
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.
Allows for
to document what is consumed and emitted in a more easily readable/parsable fashion