fix(docs): split paragraphs by both Unix and Windows newlines (backport #1103) #1131
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
Similar to #1058, the Windows newline character wasn't matched and handled accordingly. I found the problem in [this Github run](https://github.com/projen/projen/actions/runs/9536528729/job/26283592671?pr=3582#step:6:2043) which gives errors in snapshots, like the one below ```json { "default": "- No minimum version is being enforced", - "docs": "Minimal Major version to release.", + "docs": "Minimal Major version to release This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`.", "featured": false, "fullType": { "primitive": "number", }, ``` I tested that the changed works OK by packaging and installing jsii locally, getting the following correct output in the local projen `.jsii` file. ```json { "abstract": true, "docs": { "default": "- No minimum version is being enforced", "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.", "stability": "experimental", "summary": "Minimal Major version to release." }, "immutable": true, "locationInModule": { "filename": "src/release/release.ts", "line": 123 }, "name": "minMajorVersion", "optional": true, "type": { "primitive": "number" } }, ``` `.jsii` inventory file before the change : [before_change_jsii.json](https://github.com/user-attachments/files/15935939/before_change_jsii.json) `.jsii` inventory file after the change: [after_change_jsii.json](https://github.com/user-attachments/files/15935940/after_change_jsii.json) --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0 Co-authored-by: Momo Kornher <[email protected]> (cherry picked from commit edcbaed)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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.
Backport
This will backport the following commits from
maintomaintenance/v5.3:Questions ?
Please refer to the Backport tool documentation