-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Apply reformatText
to the backup .Description text
#1902
Conversation
// TODO[pulumi/pulumi-java#1271]: This should be fixed in pulumi/pulumi-java | ||
text = illegalJavaPattern.ReplaceAllString(text, "") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the java specific change here.
rawdoc, elided := reformatText(infoContext{ | ||
language: g.language, | ||
pkg: g.pkg, | ||
info: g.info, | ||
}, propschema.Description(), nil) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This puts description based docs through our general docs cleaning pipeline, including the java change.
7629901
to
b03f4da
Compare
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
reformatText
moved 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this fix pulumi/pulumi-gcp#1945?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It does not fix it, but it reduces the number of incidents.
Ensure that javadoc runs cleanly Fixes pulumi/pulumi-gcp#1950 Needs to merge **after** pulumi/pulumi-terraform-bridge#1902.
The commit has merged into master on the bridge, so will be contained in the next bridge release.
This fixes the root cause for pulumi/pulumi-gcp#1950.