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

Addon-docs/Angular: Use compodoc rawdescription where available #15774

Merged
merged 1 commit into from Aug 7, 2021

Conversation

dexster
Copy link
Contributor

@dexster dexster commented Aug 6, 2021

Issue: #15591 #14116

What I did

Use rawdescription over description for generated comments when available. rawdescription has no HTML tags and escaped characters so the Storybook comments. This will also fix the nested

error in console logs

This fixes #15591 & #14116

Compodoc also updated to 1.1.14 to allow this change.

How to test

I updated a Story property comment to include an apostrophe. Snapshots also had to be updated as HTML formatting is now removed when using rawdescription

@nx-cloud
Copy link

nx-cloud bot commented Aug 6, 2021

Nx Cloud Report

CI ran the following commands for commit f33e142. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status Command
#000000 nx run-many --target=prepare --all --parallel --max-parallel=15

Sent with 💌 from NxCloud.

@shilman shilman changed the title Use compodoc rawdescription where available Addon-docs/Angular: Use compodoc rawdescription where available Aug 7, 2021
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! thanks @dexster 🙏

@shilman shilman merged commit cc8097f into storybookjs:next Aug 7, 2021
@shilman shilman added this to the 6.4 PRs milestone Aug 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Angular: Compodoc character issues
2 participants