Mark max_decommission_year as optional#1354
Open
tsmbland wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the asset input schema documentation to explicitly mark max_decommission_year as optional and to describe its default behaviour, addressing issue #1219.
Changes:
- Update
max_decommission_yearfield notes to state it is optional. - Document the default when
max_decommission_yearis omitted.
💡 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 #1354 +/- ##
=======================================
Coverage 88.80% 88.80%
=======================================
Files 58 58
Lines 8516 8516
Branches 8516 8516
=======================================
Hits 7563 7563
Misses 640 640
Partials 313 313 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
max_decommission_year as optional
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.
Description
Marking this parameter as optional, and describing the default. It would be nice to automatically mark optional parameters, but that's probably more effort than it's worth
Copilot also flagged that we reject
max_decommission_year = commission_year, which wasn't correct in the docs before, so I've updated this and added a test.Fixes #1219
Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks