We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug Certain characters are not translated correctly. See image below of a Controls description.
This issue above is caused by an apostrophe in the jsdoc comment
This is because Compodoc does some parsing of the jsdoc when generating the description property. It also adds HTML tags to this description property
description
Compodoc 1.1.14 has a new property called rawdescription which does not encode characters or add HTML tags. The difference looks like this
rawdescription
I propose we move from using the description property to the rawdescription property. I can make the change if you're happy to go ahead with this?
The text was updated successfully, but these errors were encountered:
@shilman Is there someone who could give some feedback on this?
Sorry, something went wrong.
Thanks for the nudge @dexster -- sorry I missed this first time around.
That change sounds reasonable to me, and I think I wrote the original buggy code 😉
Zoinks!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.4.0-alpha.25 containing PR #15774 that references this issue. Upgrade today to the @next NPM tag to try it out!
@next
npx sb upgrade --prerelease
Successfully merging a pull request may close this issue.
Describe the bug
Certain characters are not translated correctly. See image below of a Controls description.
This issue above is caused by an apostrophe in the jsdoc comment
This is because Compodoc does some parsing of the jsdoc when generating the
description
property. It also adds HTML tags to thisdescription
propertyCompodoc 1.1.14 has a new property called
rawdescription
which does not encode characters or add HTML tags. The difference looks like thisI propose we move from using the
description
property to therawdescription
property. I can make the change if you're happy to go ahead with this?The text was updated successfully, but these errors were encountered: