Skip to content

docs: fix 17 typos in comments and log messages - #43

Open
Léon Simmons (Avicennasis) wants to merge 1 commit into
qualcomm:mainfrom
Avicennasis:docs/fix-typos
Open

docs: fix 17 typos in comments and log messages#43
Léon Simmons (Avicennasis) wants to merge 1 commit into
qualcomm:mainfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Pull Request

Description

Fix 17 spelling / grammar / copy-paste typos in code comments, gtk-doc blocks and GST_ERROR message strings. No functional changes and no identifiers renamed.

The commit is signed off per the DCO requirement in CONTRIBUTING.md.

Type of Change

  • Documentation update

Changes

  • gst-plugin-base/gst/utils/common-utils.h
    • // Macro to extract stage from meta ID. -> ... extract entry ... on the comment above GST_META_ID_GET_ENTRY (copy-paste from the GST_META_ID_GET_STAGE comment two lines up)
    • convinient -> convenient
    • The feature for witch to check. -> for which
    • @structure: The #GStStructure -> #GstStructure (the mis-cased type name does not resolve as a gtk-doc link)
  • gst-plugin-overlay/gstoverlay.h
    • overlay HW instacne id -> instance
    • boundind_box: boundind box rectangle -> boundind_box: bounding box rectangle (only the prose was corrected; the leading member name is left as-is so it keeps matching the real boundind_box struct field)
  • gst-plugin-mlvdetection/modules/ml-vdetection-east-textdt.c
    • Settings stucture does not ... -> structure (2 occurrences)
    • Failed to get ML info from confguration caps! -> configuration
    • Parse/Labels funtion will print ... -> function (2 occurrences)
    • Extracting the derive rotated boxes -> derived
  • gst-plugin-mlvclassification/modules/ml-vclassification-mobilenet.c
    • Settings stucture does not ... -> structure (2 occurrences)
    • Failed to get ML info from confguration caps! -> configuration
    • Parse/Labels funtion will print ... -> function (2 occurrences)

Note on scope

stucture, confguration and funtion also appear in sibling modules under gst-plugin-mlvsegmentation/, gst-plugin-mlaclassification/, gst-plugin-mlpostprocess/ and other gst-plugin-mlvdetection/modules/*.c files. Those were deliberately left out to keep this PR small; happy to extend it to a full repo-wide sweep if you would prefer that in one go.

Checklist

  • I have performed a self-review of my own code
  • My changes generate no new warnings (comment / string-literal text only)

Spelling, grammar and copy-paste fixes in code comments, gtk-doc blocks and GST_ERROR message strings. No functional changes.

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