Skip to content

docs: fix typos in doc comments and log messages - #335

Open
Avicennasis wants to merge 1 commit into
intel:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix typos in doc comments and log messages#335
Avicennasis wants to merge 1 commit into
intel:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fixes 15 spelling and grammar errors in Doxygen comments and two slog::err messages. Comments and log text only - no identifier, signature, topic name or logic is touched. Commit is DCO signed-off per CONTRIBUTING.md.

openvino_wrapper_lib/include/openvino_wrapper_lib/outputs/ros_topic_output.hpp

  • infomation -> information (13 occurrences) and infomations -> information (1)
  • objetc -> object in four @param[in] description lines
  • This class handles and publish the ... -> ... handles and publishes the ...

openvino_wrapper_lib/include/openvino_wrapper_lib/outputs/image_window_output.hpp

  • objetc -> object (12 occurrences), obejct -> object (2)
  • @brief Calculte the rotation transform -> Calculate
  • Swapped two @brief descriptions that were attached to the wrong overloads. The block documenting accept(const std::vector<HeadPoseResult> &) said "the age and gender detection result", and the block documenting accept(const std::vector<AgeGenderResult> &) said "the headpose detection result". Each @param line was already correct, so only the two @brief lines needed to trade places. The equivalent overloads in ros_topic_output.hpp are already correct, which is what makes the mismatch here clearly accidental.

openvino_param_lib/src/param_manager.cpp

  • // Pring Common Info -> // Print Common Info

openvino_wrapper_lib/src/inferences/base_filter.cpp

  • "for label comparsion" -> "for label comparison"
  • "for confidence comparsion" -> "for confidence comparison"

These two are inside slog::err output 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_obejcts is 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 as Number 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 .cpp files (and 53 .hpp), so the copy-paste in object_detection_yolov5_model.cpp is repo-wide boilerplate. Fixing one instance would be arbitrary. Happy to do all 39 as a separate PR if you want it.
  • infomation in ros_service_output.hpp and objetc in rviz_output.hpp were outside the reported scope; say the word and I will include them.

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant