Docs Readability: Newlines in Import sections #1672
Merged
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
…y line in the imports section Clean up debugs and add comments.
VenelinMartinov
approved these changes
Feb 3, 2024
iwahbe
approved these changes
Feb 5, 2024
There was a problem hiding this comment.
The GCP imports look much better. 2 things to address before merging:
-
I agree with @VenelinMartinov. Let's make sure we add a regression test for gcp-style imports.
-
If you haven't done this already, lets make sure this doesn't break imports for aws and azure.
|
This change will add extra newlines to import sections of resource descriptions across the board. It should not affect how they are displayed. A test of AWS registry docs is building here |
|
No diff in display on docs preview on AWS import instructions, see before/after screenshots. Given the ✅ here and improved rendering for GCP, I am going to merge. 
|
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.
This PR allows docsgen to retain newlines in import sections by adding a double newline placeholder to the end of every line in the
Importsection of the docs.Previously, newlines were not honored except around the import code part itself.
Tests are adjusted to reflect newlines being appended rather than prepended.
Here is a registry preview
Screenshot from that preview:
Closes pulumi/pulumi-gcp#1375.