refactor: apply snake_case to the function names#60
Merged
Conversation
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors function names across the mmros project to follow snake_case naming conventions, improving code consistency and readability.
Key Changes:
- Renamed result construction functions from
Ok/Errtomake_ok/make_err - Updated
isOk()method tois_ok()in the Result class - Renamed
appendMessagePrefix()toappend_message_prefix()in MmRosException
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mmros/include/mmros/archetype/result.hpp | Updates Result class method and factory function names to snake_case |
| mmros/include/mmros/archetype/exception.hpp | Renames MmRosException internal method to snake_case |
| mmros/src/detector/detector2d.cpp | Updates all error/success result construction calls to use new function names |
| mmros/src/detector/instance_segmeter2d.cpp | Updates all error/success result construction calls to use new function names |
| mmros/src/detector/panoptic_segmenter2d.cpp | Updates all error/success result construction calls to use new function names |
| mmros/src/detector/semantic_segmenter2d.cpp | Updates all error/success result construction calls to use new function names |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Description
This pull request refactors the error handling and result construction code across the mmros project to use more consistent and descriptive function naming. The main changes involve renaming utility functions for constructing success and error results, updating method names for checking result status, and ensuring these changes are reflected throughout all relevant detector classes. This improves code readability and aligns with modern C++ naming conventions.
Core API refactoring:
mmros/include/mmros/archetype/result.hppfromOk/Errtomake_ok/make_err, and updated all usages accordingly. [1] [2] [3] [4]isOk()method in theResultclass tois_ok()for consistency with the new naming convention.Exception handling improvements:
appendMessagePrefix()toappend_message_prefix()inMmRosExceptionand updated its usage for consistency. [1] [2] [3]Detector classes updates:
Detector2D,InstanceSegmenter2D,PanopticSegmenter2D,SemanticSegmenter2D) to use the newmake_okandmake_errfunctions for constructing results, replacing all previous usages ofOkandErr. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]How was this PR tested?
Notes for reviewers
None.
Effects on system behavior
None.