docs: Add docstrings for VEXGenerate class and methods #4544
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
Added detailed docstrings to `VEXGenerate` class, including description for class attributes, methods, and parameters. This enhances readability and provides clear guidance.
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.
This pull request enhances the VEXGenerate class by adding detailed docstrings to improve code readability and maintainability. The docstrings cover:
-Class attributes and structure.
-Method descriptions, including parameters and return types.
-Inline documentation to clarify specific lines or blocks of code.
These updates make it easier for other developers to understand and work with the VEXGenerate class.
Linked Issue:
This pull request addresses issue #4541
Changes Made:
-Added docstrings to VEXGenerate class, detailing:
-Purpose of the class.
-Functionality of each method.
-Parameters, return values, and types.
-Sample usage and expected behavior.
-Removed trailing whitespaces and applied PEP8 formatting for better compliance.
Additional Notes:
-No functional code changes were made, only documentation updates.
-Ran pre-commit hooks to ensure all formatting guidelines are met.
Checklist:
-Added docstrings as per documentation standards.
-Verified that all pre-commit hooks pass.
-Confirmed no logic changes; only documentation updates.