Repository navigation
Add examples to public function docstrings - #55
Merged
Merged
Conversation
Added docstrings to build_parser and main functions for better clarity.
Added docstrings to conversion functions for clarity.
Added a docstring to the format_json function to explain its purpose and provide an example usage.
Updated docstring to provide an example usage of the generate function.
Updated docstrings for is_palindrome and reverse_words functions to include examples.
Updated docstrings for word counting functions to provide examples and clarify their purpose.
Update example in main function docstring to reflect output.
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.
What does this PR do?
Adds usage examples to the docstrings of public functions across the
fixitpackage.Related issue
Closes #36