Handle headers in code comments #2285
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
|
Is #2260 also fixed by this? |
iwahbe
force-pushed
the
iwahbe/handle-headers-in-code-comments
branch
from
4bdeccf to
5c24869
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2285 +/- ##
==========================================
+ Coverage 56.71% 56.76% +0.05%
==========================================
Files 361 361
Lines 49547 49745 +198
==========================================
+ Hits 28099 28238 +139
- Misses 19906 19954 +48
- Partials 1542 1553 +11 ☔ View full report in Codecov by Sentry. |
I doubt it. This change is only concerned with correctly parsing |
iwahbe
force-pushed
the
iwahbe/handle-headers-in-code-comments
branch
from
405b544 to
b366ae8
Compare
iwahbe
force-pushed
the
iwahbe/handle-headers-in-code-comments
branch
from
b366ae8 to
128cbe1
Compare
iwahbe
force-pushed
the
iwahbe/handle-headers-in-code-comments
branch
from
28ab284 to
1145b5e
Compare
iwahbe
added a commit
to pulumi/pulumi-gcp
that referenced
this pull request
Aug 8, 2024
This is a pre-requisite for pulumi/pulumi-terraform-bridge#2285. pulumi/pulumi-terraform-bridge#2285 uses a real markdown parser. This correctly identifies `Collection of resources to manage IAM policy for Dataproc AutoscalingPolicy` as a H2 header, just like GH does. ```md --- # ---------------------------------------------------------------------------- # # *** AUTO GENERATED CODE *** Type: MMv1 *** # # ---------------------------------------------------------------------------- # # This file is automatically generated by Magic Modules and manual # changes will be clobbered when the file is regenerated. # # Please read more about how to change this file in # .github/CONTRIBUTING.md. # # ---------------------------------------------------------------------------- ## subcategory: "Dataproc" description: |- Collection of resources to manage IAM policy for Dataproc AutoscalingPolicy --- ``` This PR removes the second front-matter from the copied doc.
guineveresaenger
approved these changes
Aug 8, 2024
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.
Correctly handle "markdown headers" in code blocks. We do this by using goldmark to parse the markdown and find headers of the right type, then use byte offsets to extract from the original text.
This allows us to correctly parse comments like:
Fixes pulumi/pulumi-snowflake#683
I have tested this in aws, gcp, azure, cloudflare and snowflake. Snowflake fixes a great number of resources, gcp is broken due to a bad doc rewrite rule (which I will fix before merging here). The rest are unchanged.
I think we are ready to merge.