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

Add documentation to subprocess-with[out]-shell-equals-true rules #6373

Merged
merged 5 commits into from
Aug 7, 2023

Conversation

tjkuson
Copy link
Contributor

@tjkuson tjkuson commented Aug 6, 2023

Summary

Adds documentation, includes a known problems section pointing to an issue. Related to #2646.

Test Plan

python scripts/test_docs_formatted.py

@github-actions
Copy link
Contributor

github-actions bot commented Aug 6, 2023

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      8.1±0.02ms     5.0 MB/sec    1.01      8.2±0.09ms     5.0 MB/sec
formatter/numpy/ctypeslib.py               1.00  1615.6±20.90µs    10.3 MB/sec    1.01  1629.2±36.55µs    10.2 MB/sec
formatter/numpy/globals.py                 1.00    181.7±3.18µs    16.2 MB/sec    1.01    182.6±2.50µs    16.2 MB/sec
formatter/pydantic/types.py                1.03      3.5±0.15ms     7.3 MB/sec    1.00      3.4±0.04ms     7.5 MB/sec
linter/all-rules/large/dataset.py          1.00     10.1±0.04ms     4.0 MB/sec    1.00     10.1±0.05ms     4.0 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      2.7±0.01ms     6.2 MB/sec    1.00      2.7±0.01ms     6.2 MB/sec
linter/all-rules/numpy/globals.py          1.00    378.6±0.65µs     7.8 MB/sec    1.00    378.6±1.62µs     7.8 MB/sec
linter/all-rules/pydantic/types.py         1.00      4.6±0.02ms     5.5 MB/sec    1.00      4.6±0.01ms     5.5 MB/sec
linter/default-rules/large/dataset.py      1.00      5.2±0.01ms     7.9 MB/sec    1.00      5.2±0.02ms     7.8 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1112.9±2.59µs    15.0 MB/sec    1.01   1123.1±4.75µs    14.8 MB/sec
linter/default-rules/numpy/globals.py      1.00    126.6±0.67µs    23.3 MB/sec    1.00    127.1±0.69µs    23.2 MB/sec
linter/default-rules/pydantic/types.py     1.00      2.3±0.00ms    11.0 MB/sec    1.00      2.3±0.01ms    10.9 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.01      9.9±0.16ms     4.1 MB/sec    1.00      9.8±0.04ms     4.1 MB/sec
formatter/numpy/ctypeslib.py               1.01  1905.7±14.09µs     8.7 MB/sec    1.00  1893.4±17.26µs     8.8 MB/sec
formatter/numpy/globals.py                 1.00    197.6±2.25µs    14.9 MB/sec    1.01    198.7±7.83µs    14.8 MB/sec
formatter/pydantic/types.py                1.00      4.2±0.02ms     6.1 MB/sec    1.00      4.2±0.03ms     6.1 MB/sec
linter/all-rules/large/dataset.py          1.00     12.5±0.05ms     3.3 MB/sec    1.00     12.6±0.10ms     3.2 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.5±0.02ms     4.7 MB/sec    1.00      3.5±0.02ms     4.7 MB/sec
linter/all-rules/numpy/globals.py          1.01    366.7±5.10µs     8.0 MB/sec    1.00    363.6±5.79µs     8.1 MB/sec
linter/all-rules/pydantic/types.py         1.00      5.9±0.05ms     4.4 MB/sec    1.00      5.9±0.04ms     4.3 MB/sec
linter/default-rules/large/dataset.py      1.00      6.6±0.03ms     6.1 MB/sec    1.00      6.7±0.04ms     6.1 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1379.6±9.12µs    12.1 MB/sec    1.00   1379.4±9.68µs    12.1 MB/sec
linter/default-rules/numpy/globals.py      1.00    139.9±1.35µs    21.1 MB/sec    1.00    140.1±1.33µs    21.1 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.0±0.03ms     8.5 MB/sec    1.00      3.0±0.02ms     8.5 MB/sec

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Aug 7, 2023
@charliermarsh charliermarsh enabled auto-merge (squash) August 7, 2023 03:42
@charliermarsh charliermarsh merged commit 5d2a4eb into astral-sh:main Aug 7, 2023
16 checks passed
@tjkuson tjkuson deleted the shell-docs branch August 7, 2023 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants