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.

Sign up for GitHub

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

Jump to bottom

Line length limit for Markdown #582

Closed
maxitg opened this issue Dec 18, 2020 · 0 comments · Fixed by #581
Closed

Line length limit for Markdown #582

maxitg opened this issue Dec 18, 2020 · 0 comments · Fixed by #581
Assignees
@aokellermann
Labels
feature New functionality, or change in existing functionality infrastructure Has to do with changes to the development process, e.g., build scripts, CI, testing utilities

Comments

@maxitg
Copy link
Owner

maxitg commented Dec 18, 2020 •
edited
Loading

The problem

We currently have a 120 characters limit everywhere in the codebase except for Markdown files. We should use it there for consistency as well.

Possible solution

markdownlint (#581) already supports it, we just need to fix the actual files and enable it.

Alternative solutions

Would be nice to have a Markdown formatter that would split the lines automatically. Not sure if that exists.
@maxitg maxitg added feature New functionality, or change in existing functionality infrastructure Has to do with changes to the development process, e.g., build scripts, CI, testing utilities labels Dec 18, 2020
@aokellermann aokellermann self-assigned this Dec 18, 2020
@aokellermann aokellermann mentioned this issue Dec 18, 2020
Merged
aokellermann added a commit that referenced this issue Dec 18, 2020
@aokellermann
Markdown Linter (#581)
ec58541 
## Changes
* Adds [markdown linter](https://github.com/DavidAnson/markdownlint)
* Enforces 120 characters line width
* Related to #247
* Closes #582

## Examples
Some common errors:
![image](https://user-images.githubusercontent.com/26678747/102560353-08b5a880-40a0-11eb-87be-be2787ccdc6c.png)

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/maxitg/setreplace/581)
<!-- Reviewable:end -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aokellermann aokellermann

Labels
feature New functionality, or change in existing functionality infrastructure Has to do with changes to the development process, e.g., build scripts, CI, testing utilities
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Markdown Linter maxitg/SetReplace
2 participants
@maxitg @aokellermann