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

Fix Markdown Line Length #16

Merged
merged 5 commits into from
Oct 29, 2024
Merged

Fix Markdown Line Length #16

merged 5 commits into from
Oct 29, 2024

Conversation

john0isaac
Copy link
Member

@john0isaac john0isaac commented Oct 22, 2024

Description

This PR ignores line length in the markdown to pass the workflow and fixes other markdown issues.

Checklist

  • I have read the contributing guidelines.
  • [-] I have written tests for the changes, if applicable.
  • I have added necessary documentation.

Related Issues

Please reference related issues here:

@kjaymiller
Copy link
Contributor

I'm personally not a fan of MD013 as I think some markdown parsers will mess it up and adding arbitrary \n into text in the middle of sentences doesn't seem right.

I don't mind the other two fixes but I think the actual change should be to add a markdownlint.jsonc that ignores MD013.

@kjaymiller
Copy link
Contributor

README.md Outdated Show resolved Hide resolved
@john0isaac
Copy link
Member Author

done

@kjaymiller
Copy link
Contributor

Did we check that the tests pass.. I don't know if I have a linter for it or not.

@john0isaac
Copy link
Member Author

Which tests?
All of the currently configured workflows passed.

Are there any other tests you are talking about?

@kjaymiller kjaymiller merged commit 3c2280a into main Oct 29, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants