Fix/comment typos b - #1461
Open
zepp-chen wants to merge 2 commits into
Open
Conversation
Fix several documentation and example-code issues in the kernel header comments: * queue.h: remove a stray semicolon after the 'if' and correct the xHigherPriorityTaskWoken variable casing in the xQueueReceiveFromISR() example; add the missing comma between parameters in the xQueueGenericSend() prototype example. * list.h: correct the doxygen \page tag for listGET_ITEM_VALUE_OF_HEAD_ENTRY. * task.h: fix the uxIndexToCLear typo (-> uxIndexToClear). These are documentation/example only changes that do not affect the compiled library. Signed-off-by: chenrongjun <chenrongjun@zepp.com>
Correct a number of documentation typos found across the kernel
source and headers:
* Remove duplicated words ("the the", "and and", "before before",
"in a every").
* Fix "it's" used as a possessive (-> "its").
* Fix article usage ("an QueueHandle_t" -> "a QueueHandle_t", etc.).
* Fix type-name typos (list_ts -> List_t, uxItemsSize -> uxItemSize,
"great extend" -> "great extent").
These are documentation-only changes that do not affect the compiled
library.
Signed-off-by: chenrongjun <chenrongjun@zepp.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
1 participant
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
Test Steps
Checklist:
Related Issue
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.