add existing only mode #4
Open
Conversation
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
There was a problem hiding this comment.
PR Overview
This PR adds a new "existing only mode" that ensures only functions with an existing docstring are updated with exception documentation. Key changes include:
- Updating test cases to validate that functions without a docstring remain unchanged.
- Modifying process_directory and CLI argument parsing in cli.py to support a new only_existing flag.
- Enhancing docstring_utils.py to conditionally update docstrings based on the presence of an existing docstring.
Reviewed Changes
| File | Description |
|---|---|
| src/auto_detect_exceptions/tests/test_cli.py | Adds a new test to verify that only functions with an existing docstring are updated. |
| src/auto_detect_exceptions/tests/test_docstring_utils.py | Modifies the test to assert that functions lacking a docstring are not updated. |
| src/auto_detect_exceptions/cli.py | Updates process_directory signature and CLI argument parsing to incorporate the only_existing flag. |
| src/auto_detect_exceptions/docstring_utils.py | Extends DocstringUpdater and update_function_docstrings to conditionally update functions. |
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
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.
No description provided.