docs: fix typos in doc comments and log messages - #335
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
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.
Summary
Fixes 15 spelling and grammar errors in Doxygen comments and two
slog::errmessages. Comments and log text only - no identifier, signature, topic name or logic is touched. Commit is DCO signed-off perCONTRIBUTING.md.openvino_wrapper_lib/include/openvino_wrapper_lib/outputs/ros_topic_output.hppinfomation->information(13 occurrences) andinfomations->information(1)objetc->objectin four@param[in]description linesThis class handles and publish the ...->... handles and publishes the ...openvino_wrapper_lib/include/openvino_wrapper_lib/outputs/image_window_output.hppobjetc->object(12 occurrences),obejct->object(2)@brief Calculte the rotation transform->Calculate@briefdescriptions that were attached to the wrong overloads. The block documentingaccept(const std::vector<HeadPoseResult> &)said "the age and gender detection result", and the block documentingaccept(const std::vector<AgeGenderResult> &)said "the headpose detection result". Each@paramline was already correct, so only the two@brieflines needed to trade places. The equivalent overloads inros_topic_output.hppare already correct, which is what makes the mismatch here clearly accidental.openvino_param_lib/src/param_manager.cpp// Pring Common Info->// Print Common Infoopenvino_wrapper_lib/src/inferences/base_filter.cpp"for label comparsion"->"for label comparison""for confidence comparsion"->"for confidence comparison"These two are inside
slog::erroutput strings rather than comments. Nothing in the repository asserts on them -grep -rn 'comparsion\|comparison' tests/is empty and there are no other references - but flagging it so reviewers can confirm no external log parser depends on the misspelling.Deliberately NOT changed
suffix_conditons_is misspelled but it is a member variable; renaming an identifier is out of scope for a typo PR.segmented_obejctsis misspelled in 12 files but it is a published ROS topic name. Renaming it would break every subscriber, so it is left exactly as-is."Number of " << getName() << "input more than maximum("appears identically in four files (base_inference.hpp,object_detection.cpp,object_segmentation.cpp,object_segmentation_maskrcnn.cpp). Its real defect is a missing leading space, so it renders asNumber of ObjectSegmentationinput more than maximum(4). That is a four-file change to a warning message and belongs in its own PR, not this one.@brief a header file with declaration of ...appears in 39.cppfiles (and 53.hpp), so the copy-paste inobject_detection_yolov5_model.cppis repo-wide boilerplate. Fixing one instance would be arbitrary. Happy to do all 39 as a separate PR if you want it.infomationinros_service_output.hppandobjetcinrviz_output.hppwere outside the reported scope; say the word and I will include them.