Conversation
- Introduced scenario_docs attribute in AppConfig to manage documentation requirements. - Updated get_scenario_docs function to search subdirectories for documentation files. - Implemented logging for missing documentation based on scenario_docs settings. - Added comprehensive tests for scenario documentation checks, covering various scenarios.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds configurable enforcement for scenario documentation presence and improves doc discovery to support nested documentation layouts, addressing Issue #101.
Changes:
- Added
scenario_docssetting toAppConfig(warn/required/ignore) to control behavior when docs are missing. - Enhanced
get_scenario_docs()to search for*.mddocumentation files in subdirectories. - Added tests covering doc lookup and scenario docs enforcement behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/openutm_verification/core/execution/config_models.py |
Adds scenario_docs configuration option to the root config model. |
src/openutm_verification/core/execution/dependencies.py |
Implements recursive doc lookup and enforces warning/error behavior during scenario iteration. |
tests/test_scenario_docs_check.py |
Adds unit tests for doc lookup and scenario_docs modes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ynamic path in messages
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.
Implement #101