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.

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

Angular: Compodoc character issues #15591

Closed
dexster opened this issue Jul 14, 2021 · 3 comments · Fixed by #15774
Closed

Angular: Compodoc character issues #15591

dexster opened this issue Jul 14, 2021 · 3 comments · Fixed by #15774

Comments

@dexster
Copy link
Contributor

dexster commented Jul 14, 2021

Describe the bug
Certain characters are not translated correctly. See image below of a Controls description.
Screenshot 2021-07-14 at 23 10 00

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

Compodoc 1.1.14 has a new property called rawdescription which does not encode characters or add HTML tags. The difference looks like this

Screenshot 2021-07-14 at 23 21 00

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?

@dexster
Copy link
Contributor Author

dexster commented Aug 6, 2021

@shilman Is there someone who could give some feedback on this?

@shilman
Copy link
Member

shilman commented Aug 6, 2021

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 😉

@shilman
Copy link
Member

shilman commented Aug 7, 2021

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!

npx sb upgrade --prerelease

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants