diff options
| author | Téo Bouvard <teobouvard@gmail.com> | 2022-03-07 20:18:10 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-07 20:18:10 +0100 |
| commit | c80bf2a7579545f381e71dd33adf6b3517a7651d (patch) | |
| tree | e6a7dd66748afe43b1f1fecc9cf9c6d496fd980f /README.rst | |
| parent | 499a5306fcc2a46c7431354e087df0edffb6f3d3 (diff) | |
| download | pylint-git-c80bf2a7579545f381e71dd33adf6b3517a7651d.tar.gz | |
Fix Markdown link in ReStructuredText README (#5870)
This commit updates a link formatted using Markdown syntax to use
ReStructuredText syntax, which is what the README file is written in.
This allows a prettier link visualization in GitHub, by not displaying
the full URL between parentheses.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/README.rst b/README.rst index fb2411447..4967a00f9 100644 --- a/README.rst +++ b/README.rst @@ -168,8 +168,7 @@ Use the badge in your project's README.rst (or any other rst file):: If you use GitHub Actions, and one of your CI workflows begins with "name: pylint", you -can use GitHub's -[workflow status badges](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge#using-the-workflow-file-name) +can use GitHub's `workflow status badges <https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge#using-the-workflow-file-name>`_ to show an up-to-date indication of whether pushes to your default branch pass pylint. For more detailed information, check the documentation. |