Ml2 write docstring to file #19
Merged
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
mikem2m
approved these changes
Jan 17, 2025
There was a problem hiding this comment.
Looks good @Lukman-Lateef. Just some feedback you might want to / might not want to implement
| if not isinstance(docstring, str) or not docstring.strip(): | ||
| raise ValueError("The docstring is empty, None, or contains only whitespace") | ||
|
|
||
| print("Generated Docstring:\n") |
There was a problem hiding this comment.
I don't think we need these 3 print statements
| try: | ||
| with open(output_file, 'w') as file: | ||
| file.write(docstring) | ||
| print(f"Docstring successfully written to {output_file}") |
| file.write(docstring) | ||
| print(f"Docstring successfully written to {output_file}") | ||
| except Exception as e: | ||
| print(f"An error occurred while writing to the file: {e}") |
There was a problem hiding this comment.
We can keep this, but use raise ValueError instead :)
| """Fixture for an empty docstring.""" | ||
| return " " | ||
|
|
||
| def test_print_only(valid_docstring, capsys): |
There was a problem hiding this comment.
I think we don't need this test, but damn I didnt know you could do that. Good stuff though
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.