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

chore: guard against overzealous md/jsdoc linting #400

Merged
merged 1 commit into from
May 4, 2024

Conversation

andretchen0
Copy link
Contributor

@andretchen0 andretchen0 commented May 2, 2024

Problem

The new linter rules remove markdown formatting in some circumstances. #398

Solution

For the affected text, change:

/**
 * * list item 1
 * * list item 2
 **/

to:

/**
 * - list item 1
 * - list item 2
 **/

Copy link

stackblitz bot commented May 2, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@andretchen0 andretchen0 marked this pull request as ready for review May 2, 2024 22:32
@andretchen0 andretchen0 merged commit 8dcef2d into main May 4, 2024
3 checks passed
@andretchen0 andretchen0 deleted the docs/fix-markdown-for-linter branch May 4, 2024 03:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants