Skip to content

Commit 63332cb

Browse files
authored
Remove references to "blacklist" and "whitelist" (#13644)
1 parent 4b2b333 commit 63332cb

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

.github/test_plan.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ enable=bad-names
155155

156156
```python3
157157
# example.py
158-
foo = 42 # Marked as a blacklisted name.
158+
foo = 42 # Marked as a disallowed name.
159159
```
160160

161161
- [ ] Installation via the prompt installs Pylint as appropriate
@@ -576,12 +576,14 @@ def test_failure():
576576
1. Run a cell on the host
577577
1. Verify the editor opens on the guest and the cell is run there too
578578
- [ ] Jupyter Hub support
579+
579580
1. Windows install instructions
581+
580582
1. Install Docker Desktop onto a machine
581583
1. Create a folder with a file 'Dockerfile' in it.
582584
1. Mark the file to look like so:
583585

584-
```
586+
```
585587
ARG BASE_CONTAINER=jupyterhub/jupyterhub
586588
FROM $BASE_CONTAINER
587589
@@ -590,28 +592,26 @@ def test_failure():
590592
USER $NB_UID
591593
```
592594
593-
1. From a command prompt (in the same folder as the Dockerfile), run ```docker build -t jupyterhubcontainer:1.0 .```
594-
1. Run ```docker container create --name jupyterhub jupyterhubcontainer:1.0 jupyterhub```
595-
1. From the docker desktop app, start the jupyterhub container.
596-
1. From the docker desktop app, run the CLI
595+
1. From a command prompt (in the same folder as the Dockerfile), run `docker build -t jupyterhubcontainer:1.0 .`
596+
1. Run `docker container create --name jupyterhub jupyterhubcontainer:1.0 jupyterhub`
597+
1. From the docker desktop app, start the jupyterhub container.
598+
1. From the docker desktop app, run the CLI
599+
597600
1. OR Mac / Linux install instructions
598601
1. Install docker
599-
1. From the terminal ```docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub```
600-
1. Open a terminal in the docker container with ```docker exec -it jupyterhub bash```
601-
1. From that terminal run ```python3 -m pip install notebook```
602-
1. From the new command prompt, run ```adduser testuser```
602+
1. From the terminal `docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub`
603+
1. Open a terminal in the docker container with `docker exec -it jupyterhub bash`
604+
1. From that terminal run `python3 -m pip install notebook`
605+
1. From the new command prompt, run `adduser testuser`
603606
1. Follow the series of prompts to add a password for this user
604607
1. Open VS code
605608
1. Open a folder with a python file in it.
606-
1. Run the ```Python: Specify local or remote Jupyter server for connections``` command.
609+
1. Run the `Python: Specify local or remote Jupyter server for connections` command.
607610
1. Pick 'Existing'
608-
1. Enter ```http://localhost:8000``` (assuming the jupyter hub container was successful in launching)
611+
1. Enter `http://localhost:8000` (assuming the jupyter hub container was successful in launching)
609612
1. Reload VS code and reopen this folder.
610613
1. Run a cell in a python file.
611-
[ ] Verify results
612-
1. Verify you are asked first for a user name and then a password.
613-
1. Verify a cell runs once you enter the user name and password
614-
1. Verify that the python that is running in the interactive window is from the docker container (if on windows it should show a linux path)
614+
[ ] Verify results 1. Verify you are asked first for a user name and then a password. 1. Verify a cell runs once you enter the user name and password 1. Verify that the python that is running in the interactive window is from the docker container (if on windows it should show a linux path)
615615
616616
#### P2 Test Scenarios
617617

news/3 Code Health/13647.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove usage of the terms "blacklist" and "whitelist".

src/client/datascience/interactive-common/linkProvider.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const LineQueryRegex = /line=(\d+)/;
1717

1818
// The following list of commands represent those that can be executed
1919
// in a markdown cell using the syntax: https://command:[my.vscode.command].
20-
const linkCommandWhitelist = [
20+
const linkCommandAllowList = [
2121
'python.datascience.gatherquality',
2222
'python.datascience.latestExtension',
2323
'python.datascience.enableLoadingWidgetScriptsFromThirdPartySource'
@@ -58,7 +58,7 @@ export class LinkProvider implements IInteractiveWindowListener {
5858
if (command.endsWith('/')) {
5959
command = command.substring(0, command.length - 1);
6060
}
61-
if (linkCommandWhitelist.includes(command)) {
61+
if (linkCommandAllowList.includes(command)) {
6262
commands.executeCommand(command, params);
6363
}
6464
} else {

0 commit comments

Comments
 (0)