Skip to content

Commit

Permalink
Fix references to the default branch name (#810)
Browse files Browse the repository at this point in the history
The primary branch name has been renamed from master to main.
As a result of this, some references in the docs must also be
renamed so links are preserved.

Signed-off-by: Eric Brown <browne@vmware.com>
  • Loading branch information
ericwb committed Feb 14, 2022
1 parent c4372a0 commit dbefd04
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -18,7 +18,7 @@ Here are guidelines and rules that can be helpful if you plan to want to get inv
* [Extending Bandit](#extending-bandit)

## Code of Conduct
Everyone who participates in this project is governed by the PyCQA [Code of Conduct](https://github.com/PyCQA/bandit/blob/master/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).
Everyone who participates in this project is governed by the PyCQA [Code of Conduct](https://github.com/PyCQA/bandit/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct).

## Reporting Bugs
If you encounter a bug, please let us know about it. See the guide here [GitHub issues](https://guides.github.com/features/issues/).
Expand Down
8 changes: 4 additions & 4 deletions README.rst
@@ -1,4 +1,4 @@
.. image:: https://github.com/PyCQA/bandit/blob/master/logo/logotype-sm.png
.. image:: https://github.com/PyCQA/bandit/blob/main/logo/logotype-sm.png
:alt: Bandit

======
Expand All @@ -24,7 +24,7 @@
:alt: Format

.. image:: https://img.shields.io/badge/license-Apache%202-blue.svg
:target: https://github.com/PyCQA/bandit/blob/master/LICENSE
:target: https://github.com/PyCQA/bandit/blob/main/LICENSE
:alt: License

A security linter from PyCQA
Expand All @@ -33,7 +33,7 @@ A security linter from PyCQA
* Documentation: https://bandit.readthedocs.io/en/latest/
* Source: https://github.com/PyCQA/bandit
* Bugs: https://github.com/PyCQA/bandit/issues
* Contributing: https://github.com/PyCQA/bandit/blob/master/CONTRIBUTING.md
* Contributing: https://github.com/PyCQA/bandit/blob/main/CONTRIBUTING.md

Overview
--------
Expand Down Expand Up @@ -64,7 +64,7 @@ Contributing
------------

Follow our Contributing file:
https://github.com/PyCQA/bandit/blob/master/CONTRIBUTING.md
https://github.com/PyCQA/bandit/blob/main/CONTRIBUTING.md

Reporting Bugs
--------------
Expand Down
2 changes: 1 addition & 1 deletion bandit/core/manager.py
Expand Up @@ -450,7 +450,7 @@ def _find_candidate_matches(unmatched_issues, results_list):
be able to pick out the new one.
:param unmatched_issues: List of issues that weren't present before
:param results_list: Master list of current Bandit findings
:param results_list: main list of current Bandit findings
:return: A dictionary with a list of candidates for each issue
"""

Expand Down
2 changes: 1 addition & 1 deletion doc/requirements.txt
@@ -1,5 +1,5 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
sphinx>=4.0.0 # BSD
sphinx-rtd-theme>=0.3.0
4 changes: 2 additions & 2 deletions doc/source/conf.py
Expand Up @@ -21,8 +21,8 @@
# The suffix of source filenames.
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"
# The root toctree document.
root_doc = "index"

# General information about the project.
project = "Bandit"
Expand Down

0 comments on commit dbefd04

Please sign in to comment.