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

Add a Discord link to the docs #870

Merged
merged 1 commit into from
Apr 2, 2022
Merged

Add a Discord link to the docs #870

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@ Contributing

* `Source code`_
* `Issue tracker`_
* Join us on `Discord`_

.. _`Source code`: https://github.com/PyCQA/bandit
.. _`Issue tracker`: https://github.com/PyCQA/bandit/issues
.. _`Discord`: https://discord.gg/qYxpadCgkx
Comment on lines 28 to +30
Copy link
Member

Choose a reason for hiding this comment

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

Believe it or not, these don't need the backticks around them, they can be more simply:

.. _Source code: ...
.. _Issue tracker: ...
.. _Discord: ...

but that's not important

Copy link
Member Author

Choose a reason for hiding this comment

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

I notice in my IDE at least, it will de-highlight the line as if it's a comment or hidden text when using the back ticks. That might help to inform people these lines are not intended to be visible, just for link mapping.

Copy link
Member

Choose a reason for hiding this comment

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

I think that's a bug with your IDE not supporting a superior documentation format then ;)


Indices and tables
==================
Expand Down