Some suggestions for minor text improvements in the docs #255
Conversation
This file contains 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
This commit fixes a duplicated definite article 'the' in the last section and moves the corrected paragraph to the "Overview" section. This change is made because the paragraph contains the Wiki link that provides valuable information about libmetal internals, including a detailed section titled "OpenAMP Overview". It also addresses multiple format issues, including missing or duplicate spaces in the text, and corrects the line length to match the format used in README.md. Signed-off-by: Gustavo Romero <[email protected]>
Remove duplicated indefinite article in the text. Signed-off-by: Gustavo Romero <[email protected]>
|
@gromero Thanks for this change. This looks good to me. |
arnopo
reviewed
Oct 2, 2023
Hi @arnopo . Just because most of the doc is already formatted as 80 chars. |
Yes mainly due to legacy 80 chars imposed by Linux Kernel coding rules. That said 80 chars is under 100 so you respect the library coding rules. So OK for me |
arnopo
approved these changes
Oct 3, 2023
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.
Just some suggestions for minor text improvements I have after going through the libmetal docs.
Cheers,
Gustavo