diff --git a/README.md b/README.md index a579c131..964f84b0 100644 --- a/README.md +++ b/README.md @@ -62,19 +62,19 @@ error[preamble-order]: preamble header `description` must come after `title` ## Lints -| id | Description | +| id | Description | |-------------------------------------|-----------------------------------------------------------------------------------------------| | `markdown-html-comments` | There are no HTML comments in review-ready EIPs | | `markdown-json-cite` | All `csl-json` code blocks adhere to the correct schema. | | `markdown-link-first` | First mention of an EIP must be a link. | | `markdown-link-status` | EIPs linked in the body have statuses further along than the current proposal. | | `markdown-no-backticks` | No proposals are referenced inside backticks (eg. \`EIP-1234\`). | -| `markdown-prevent-url` | All URLs must not be in backticks. +| `markdown-prevent-url` | Only allow example/invalid domains inside backticks (eg. \`example.com\` is fine.) | | `markdown-order-section` | There are no extra sections and the sections are in the correct order. | | `markdown-re-eip-dash` | Other EIPs are referenced using EIP-X, not EIPX or EIP X. | | `markdown-re-erc-dash` | Other ERCs are referenced using ERC-X, not ERCX or ERC X. | | `markdown-refs` | ERCs are referenced using ERC-X, while other proposals use EIP-X. | -| `markdown-rel-links` | All URLs in the page must be hyperlink. It prevents backticks, plain text. Etc. | +| `markdown-rel-links` | All URLs in the page must be hyperlink. It prevents backticks, plain text. Etc. | | `markdown-req-section` | Required sections are present in the body of the proposal. | | `markdown-headings-space` | Headers have a space after the leading '#' characters | | `preamble-author` | The author header is correctly formatted, and there is at least one GitHub user listed. |