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

Markdown Linter #581

Merged
merged 9 commits into from
Dec 18, 2020
Merged

Markdown Linter #581

merged 9 commits into from
Dec 18, 2020

Conversation

aokellermann
Copy link
Collaborator

@aokellermann aokellermann commented Dec 18, 2020

Changes

Examples

Some common errors:
image


This change is Reviewable

@aokellermann aokellermann 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 requested a review from maxitg December 18, 2020 00:44
Copy link
Owner

@maxitg maxitg left a comment

Choose a reason for hiding this comment

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

Reviewed 18 of 18 files at r1.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @aokellermann)


.markdownlint.json, line 7 at r1 (raw file):

  "no-blanks-blockquote": false,
  "no-duplicate-heading": false
}

Add an empty line at the end of the file.


.github/CONTRIBUTING.md, line 27 at r1 (raw file):

3. Fill in all the fields including:

  * Brief description in natural language.

This should actually be indented by an extra space (without empty lines before and after). Then, it is correctly displayed as a sublist of (3), and the lint errors disappear without the need to disable them.


.github/CONTRIBUTING.md, line 188 at r1 (raw file):

<!-- markdownlint-disable-next-line fenced-code-language -->

Would console work for the language?


Research/ConfluenceAndCausalInvariance/ConfluenceAndCausalInvariance.md, line 19 at r1 (raw file):

> In a terminating system, causal invariance implies that whatever path is taken, the "answer" will always be the same.

> **Confluence**: A simplified form of causal invariance considered in term rewriting systems such as ones that reach fixed points.

This file tries to follow 120 characters limit (which I think we should start using at some point). Why merge the lines?


Research/LocalMultiwaySystem/LocalMultiwaySystem.md, line 426 at r1 (raw file):

3. Consider all vertices with out-degree zero (the future boundary of the intersection):

* If the boundary contains either `A` or `B`, they are timelike separated

This should be indented by 3 spaces as a sublist of (3).

Copy link
Collaborator Author

@aokellermann aokellermann left a comment

Choose a reason for hiding this comment

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

Reviewable status: 4 of 55 files reviewed, 5 unresolved discussions (waiting on @aokellermann and @maxitg)


.markdownlint.json, line 7 at r1 (raw file):

Previously, maxitg (Max Piskunov) wrote…

Add an empty line at the end of the file.

Done.

Copy link
Owner

@maxitg maxitg left a comment

Choose a reason for hiding this comment

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

Reviewed 51 of 51 files at r2.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@aokellermann aokellermann merged commit ec58541 into master Dec 18, 2020
@aokellermann aokellermann deleted the MarkdownLinter branch December 18, 2020 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

Line length limit for Markdown
2 participants