Closed
Conversation
Merged
hukkin
commented
Mar 30, 2021
Comment on lines
+19
to
+22
| \- [Custody slashings](#custody-slashings) | ||
| \- [Custody key reveals](#custody-key-reveals) | ||
| \- [Early derived secret reveals](#early-derived-secret-reveals) | ||
| - [Construct attestation](#construct-attestation) |
Author
There was a problem hiding this comment.
These changes are not a formatting error of the formatter. Instead, the ToC is broken (see the HTML rendering).
Author
There was a problem hiding this comment.
This is a bug in DocToc that occurs when heading level increments by more than one. In this document there is a jump from ## Second level to ##### Fifth level heading that confuses DocToc. I could replace DocToc with mdformat-toc plugin to autogenerate ToCs, if desired. It doesn't suffer from this bug, and there would be one less tool to use.
Author
|
Should I update or close this PR? @djrtwo BTW, the Table of Contents in |
Member
|
Thanks @hukkin! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is continuation on the discussion in #2248, adding a Markdown formatter configuration to the repository and formatting all Markdown with it.
If this is considered to be merged, there's some configuration that should be tweaked according to this repo's preferences, for more detail read the downmost comments in #2248 (i.e. #2248 (comment) and #2248 (comment))
This PR currently includes a
.pre-commit-config.yamlfile which makes it as simple aspip install pre-commit && pre-commit installfor a contributor to set up a git pre commit hook to automatically format before committing. It also acts as a configuration file for https://pre-commit.ci/ which is a CI that can be set up to automatically commit formatting fixes to PRs.