Apply reformatText to the backup .Description text
#1902
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
iwahbe
commented
Apr 25, 2024
Comment on lines
+2198
to
+2199
| // TODO[pulumi/pulumi-java#1271]: This should be fixed in pulumi/pulumi-java | ||
| text = illegalJavaPattern.ReplaceAllString(text, "") |
There was a problem hiding this comment.
This is the java specific change here.
Comment on lines
+1257
to
+1261
| rawdoc, elided := reformatText(infoContext{ | ||
| language: g.language, | ||
| pkg: g.pkg, | ||
| info: g.info, | ||
| }, propschema.Description(), nil) |
There was a problem hiding this comment.
This puts description based docs through our general docs cleaning pipeline, including the java change.
iwahbe
force-pushed
the
iwahbe/reformat-.Description-based-text
branch
from
7629901
to
b03f4da
Compare
iwahbe
added a commit
to pulumi/ci-mgmt
that referenced
this pull request
Apr 25, 2024
Fixes pulumi/pulumi-gcp#1950 Needs to merge **after** pulumi/pulumi-terraform-bridge#1902.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1902 +/- ##
=======================================
Coverage 60.25% 60.26%
=======================================
Files 328 328
Lines 44322 44331 +9
=======================================
+ Hits 26706 26715 +9
Misses 16120 16120
Partials 1496 1496 ☔ View full report in Codecov by Sentry. |
| @@ -67,7 +67,7 @@ | |||
| "additionalProperties": { | |||
| "$ref": "pulumi.json#/Any" | |||
| }, | |||
| "description": "Arbitrary map of values that, when changed, will trigger recreation of resource. See [the main provider\ndocumentation](../index.html) for more information.\n", | |||
| "description": "Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for\nmore information.\n", | |||
There was a problem hiding this comment.
This change is odd - is the link removal expected?
The newline in the middle certainly doesn't look intended.
There was a problem hiding this comment.
I believe the change is correct.
- We the remove relative links because the registry doesn't have the same structure as upstream's docs. This is intentional.
- The newline is present in the upstream doc.
reformatTextmoved it, but it doesn't look like a negative change.
| @@ -2291,8 +2291,7 @@ | |||
| "type": "string" | |||
| }, | |||
| "forceDestroy": { | |||
| "type": "boolean", | |||
| "description": "Delete user even if it has non-Terraform-managed IAM access keys, login profile or MFA devices\n" | |||
There was a problem hiding this comment.
Does this fix pulumi/pulumi-gcp#1945?
There was a problem hiding this comment.
It does not fix it, but it reduces the number of incidents.
VenelinMartinov
approved these changes
Apr 25, 2024
iwahbe
added a commit
to pulumi/ci-mgmt
that referenced
this pull request
Apr 25, 2024
Ensure that javadoc runs cleanly Fixes pulumi/pulumi-gcp#1950 Needs to merge **after** pulumi/pulumi-terraform-bridge#1902.
iwahbe
added a commit
to pulumi/pulumi-gcp
that referenced
this pull request
Apr 26, 2024
The commit has merged into master on the bridge, so will be contained in the next bridge release.
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 fixes the root cause for pulumi/pulumi-gcp#1950.