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.

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

Replace term 'blacklist' with 'denylist' #12301

Closed
wants to merge 2 commits into from

Conversation

MaxRau
Copy link

@MaxRau MaxRau commented Apr 17, 2024

Subject: Remove term blacklist from Sphinx repo

Feature or Bugfix

  • Bugfix

Purpose

Many organizations (including my employer) have inclusive language policies. There are a few references to a commonly banned term, 'blacklist'. This PR removes those few references.

Detail

In some cases some organizations might limit or bar the use of Sphinx if automated checkers like Acrolinx find this term in files like doctools.js after sphinx documentation is generated.

Relates

@chrisjsewell
Copy link
Member

great thanks, I did a search for "whitelist", and its only in .ruff.toml, so might also want to change that

EXTENSION_BLACKLIST, BLACKLISTED_KEY_CONTROL_ELEMENTS, are technically public API, so perhaps they have to be deprecated 🤔 (although I doubt anyone uses them)

see e.g.

# deprecated name -> (object to return, canonical path or empty string, removal version)

not sure how/if can do that for .js

@AA-Turner
Copy link
Member

Thanks for the PR Max -- for now I'd prefer to avoid unneeded churn, though if Sphinx does start flag up on such an automated checker & it is unconfigurable, we can revisit this PR later.

A

@AA-Turner AA-Turner closed this Apr 17, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants