Skip to content
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.

Sign up for GitHub

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

Jump to bottom

API docs double-quote strings with Unicode curly quotation marks #1343

Closed
AaronFriel opened this issue Feb 15, 2024 · 0 comments · Fixed by #1399
Closed

API docs double-quote strings with Unicode curly quotation marks #1343

AaronFriel opened this issue Feb 15, 2024 · 0 comments · Fixed by #1399
Assignees
@mikhailshilkov
Labels
area/docs Improvements or additions to documentation impact/usability Something that impacts users' ability to use the product easily and intuitively kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed

Comments

@AaronFriel
Copy link
Contributor

As seen in the API docs for aws-native.s3.Bucket, the first example has

const recordingConfiguration = new aws_native.ivs.RecordingConfiguration("recordingConfiguration", {
    name: "“MyRecordingConfiguration”",
...

It may be the source documentation is using unicode quotation marks U+201C and U+201D “”, and those should be treated as regular quotes? I'm fairly sure this example won't work as a result of the quotes.

A GitHub code search suggests we should probably clean that up and replace these with plain ASCII quotes: https://github.com/search?q=repo%3Apulumi%2Fpulumi-aws-native%20%E2%80%9D&type=code
@AaronFriel AaronFriel added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Feb 15, 2024
@mjeffryes mjeffryes added area/docs Improvements or additions to documentation impact/usability Something that impacts users' ability to use the product easily and intuitively and removed needs-triage Needs attention from the triage team labels Feb 17, 2024
@mikhailshilkov mikhailshilkov mentioned this issue Mar 8, 2024
Merged
@mikhailshilkov mikhailshilkov self-assigned this Mar 8, 2024
mikhailshilkov added a commit that referenced this issue Mar 11, 2024
@mikhailshilkov
Sanitize quotation marks read from CFN files (#1399)
6d802c5 
Replace unicode quotation marks U+201C and U+201D “” that we read from
cloudformation files with canonical ones to avoid rendering issues in
the docs.

Fix #1343
@pulumi-bot pulumi-bot added the resolution/fixed This issue was fixed label Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mikhailshilkov mikhailshilkov

Labels
area/docs Improvements or additions to documentation impact/usability Something that impacts users' ability to use the product easily and intuitively kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Sanitize quotation marks read from CFN files pulumi/pulumi-aws-native
4 participants
@AaronFriel @mjeffryes @mikhailshilkov @pulumi-bot