Skip to content

Commit fa6dac8

Browse files
Removed leading $ from cli code blocks (#3174)
Co-authored-by: Tom Christie <[email protected]>
1 parent a7092af commit fa6dac8

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ and async APIs**.
2222
Install HTTPX using pip:
2323

2424
```shell
25-
$ pip install httpx
25+
pip install httpx
2626
```
2727

2828
Now, let's get started:
@@ -43,7 +43,7 @@ Now, let's get started:
4343
Or, using the command-line client.
4444

4545
```shell
46-
$ pip install 'httpx[cli]' # The command line client is an optional dependency.
46+
pip install 'httpx[cli]' # The command line client is an optional dependency.
4747
```
4848

4949
Which now allows us to use HTTPX directly from the command-line...
@@ -94,13 +94,13 @@ Plus all the standard features of `requests`...
9494
Install with pip:
9595

9696
```shell
97-
$ pip install httpx
97+
pip install httpx
9898
```
9999

100100
Or, to include the optional HTTP/2 support, use:
101101

102102
```shell
103-
$ pip install httpx[http2]
103+
pip install httpx[http2]
104104
```
105105

106106
HTTPX requires Python 3.8+.

docs/advanced/proxies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ This is an optional feature that requires an additional third-party library be i
7373
You can install SOCKS support using `pip`:
7474

7575
```shell
76-
$ pip install httpx[socks]
76+
pip install httpx[socks]
7777
```
7878

7979
You can now configure a client to make requests via a proxy using the SOCKS protocol:

docs/contributing.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ Then clone your fork with the following command replacing `YOUR-USERNAME` with
4646
your GitHub username:
4747

4848
```shell
49-
$ git clone https://github.com/YOUR-USERNAME/httpx
49+
git clone https://github.com/YOUR-USERNAME/httpx
5050
```
5151

5252
You can now install the project and its dependencies using:
5353

5454
```shell
55-
$ cd httpx
56-
$ scripts/install
55+
cd httpx
56+
scripts/install
5757
```
5858

5959
## Testing and Linting
@@ -64,7 +64,7 @@ and documentation building workflow.
6464
To run the tests, use:
6565

6666
```shell
67-
$ scripts/test
67+
scripts/test
6868
```
6969

7070
!!! warning
@@ -76,19 +76,19 @@ Any additional arguments will be passed to `pytest`. See the [pytest documentati
7676
For example, to run a single test script:
7777

7878
```shell
79-
$ scripts/test tests/test_multipart.py
79+
scripts/test tests/test_multipart.py
8080
```
8181

8282
To run the code auto-formatting:
8383

8484
```shell
85-
$ scripts/lint
85+
scripts/lint
8686
```
8787

8888
Lastly, to run code checks separately (they are also run as part of `scripts/test`), run:
8989

9090
```shell
91-
$ scripts/check
91+
scripts/check
9292
```
9393

9494
## Documenting
@@ -98,7 +98,7 @@ Documentation pages are located under the `docs/` folder.
9898
To run the documentation site locally (useful for previewing changes), use:
9999

100100
```shell
101-
$ scripts/docs
101+
scripts/docs
102102
```
103103

104104
## Resolving Build / CI Failures
@@ -122,7 +122,7 @@ This job failing means there is either a code formatting issue or type-annotatio
122122
You can look at the job output to figure out why it's failed or within a shell run:
123123

124124
```shell
125-
$ scripts/check
125+
scripts/check
126126
```
127127

128128
It may be worth it to run `$ scripts/lint` to attempt auto-formatting the code

docs/http2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ trying out our HTTP/2 support. You can do so by first making sure to install
2828
the optional HTTP/2 dependencies...
2929

3030
```shell
31-
$ pip install httpx[http2]
31+
pip install httpx[http2]
3232
```
3333

3434
And then instantiating a client with HTTP/2 support enabled:

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ HTTPX is a fully featured HTTP client for Python 3, which provides sync and asyn
2828
Install HTTPX using pip:
2929

3030
```shell
31-
$ pip install httpx
31+
pip install httpx
3232
```
3333

3434
Now, let's get started:
@@ -50,7 +50,7 @@ Or, using the command-line client.
5050

5151
```shell
5252
# The command line client is an optional dependency.
53-
$ pip install 'httpx[cli]'
53+
pip install 'httpx[cli]'
5454
```
5555

5656
Which now allows us to use HTTPX directly from the command-line...
@@ -130,19 +130,19 @@ inspiration around the lower-level networking details.
130130
Install with pip:
131131

132132
```shell
133-
$ pip install httpx
133+
pip install httpx
134134
```
135135

136136
Or, to include the optional HTTP/2 support, use:
137137

138138
```shell
139-
$ pip install httpx[http2]
139+
pip install httpx[http2]
140140
```
141141

142142
To include the optional brotli and zstandard decoders support, use:
143143

144144
```shell
145-
$ pip install httpx[brotli,zstd]
145+
pip install httpx[brotli,zstd]
146146
```
147147

148148
HTTPX requires Python 3.8+

0 commit comments

Comments
 (0)