Update development tooling configuration #126
Merged
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
Corrected various spelling errors and comments across multiple files, including 'Gazebo Simulatore' to 'Gazebo Simulate' and 'degress' to 'degrees'. Renamed message files and updated imports and references from 'Reponse' to 'Response' for consistency in om_api and orchestrator modules. Added typos pre-commit hook and configuration for improved typo detection.
This commit adds and refines docstrings for classes, methods, and functions across multiple modules, clarifying their purpose and usage. It standardizes parameter and return value documentation to use NumPy-style sections, improving code readability and maintainability for developers.
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 primarily improves code documentation and updates development tooling configuration. The main changes include standardizing and clarifying docstrings for better readability, correcting minor typos, and refining pre-commit hooks to ensure consistent code formatting and typo checking.
Documentation Improvements:
costmap_client.py,explore.py, andfrontier_search.pyfor improved readability and consistency. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23] [24] [25] [26] [27] [28] [29] [30] [31]Development Tooling Updates:
.pre-commit-config.yamlto adjustblackandisortversions, add thetyposhook for spell checking, and remove redundantisortconfiguration..typos.tomlto configure custom word ignore rules for thetypospre-commit hook.Minor Documentation and Typo Fixes:
README.md, correcting "Gazebo Simulatore" to "Gazebo Simulate". [1] [2]