DOCS: Add final newline to markdown files#19645
Merged
Merged
Conversation
Several documentation files were missing a final newline character. This change adds them to adhere to POSIX conventions and improve compatibility with various text-processing tools. It also helps to create cleaner diffs in the future.
|
You can test this PR using the following package version. |
Collaborator
|
Member
|
Note: we do have |
Member
|
(Waiting for the CLA to be signed before merging) |
Contributor
Author
|
@cla-avalonia agree |
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
4 participants
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.
This PR adds a missing final newline character to several documentation files, including api-compat.md and build.md.
Adding a final newline is a standard POSIX convention for text files. This change improves compatibility with various command-line tools and helps keep Git diffs clean and easy to read.
The POSIX standard defines a Line as:
https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#:~:text=3.206%20Line,terminating%20%3Cnewline%3E%20character.
This means that for a sequence of characters to be considered a complete "line" according to the standard, it must end with a newline. A file that lacks a final newline has an incomplete last line and is therefore not a strictly compliant POSIX text file.