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

Fix PT005 doc #6596

Merged
merged 1 commit into from
Aug 15, 2023
Merged

Fix PT005 doc #6596

merged 1 commit into from
Aug 15, 2023

Conversation

harupy
Copy link
Contributor

@harupy harupy commented Aug 15, 2023

Summary

#2646

The docstring location is incorrect.

Test Plan

image

Signed-off-by: harupy <hkawamura0130@gmail.com>
@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Aug 15, 2023
@charliermarsh charliermarsh enabled auto-merge (squash) August 15, 2023 12:41
@charliermarsh charliermarsh merged commit 81b1176 into astral-sh:main Aug 15, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 15, 2023

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.05      4.8±0.04ms     8.5 MB/sec    1.00      4.5±0.07ms     9.0 MB/sec
formatter/numpy/ctypeslib.py               1.06    958.0±3.95µs    17.4 MB/sec    1.00   901.3±10.52µs    18.5 MB/sec
formatter/numpy/globals.py                 1.07     98.0±0.50µs    30.1 MB/sec    1.00     91.7±3.82µs    32.2 MB/sec
formatter/pydantic/types.py                1.06  1922.4±42.30µs    13.3 MB/sec    1.00  1820.2±26.31µs    14.0 MB/sec
linter/all-rules/large/dataset.py          1.00     12.2±0.18ms     3.3 MB/sec    1.02     12.5±0.11ms     3.2 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.2±0.05ms     5.1 MB/sec    1.03      3.3±0.02ms     5.0 MB/sec
linter/all-rules/numpy/globals.py          1.00    470.3±9.29µs     6.3 MB/sec    1.01    473.9±0.97µs     6.2 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.4±0.06ms     4.0 MB/sec    1.01      6.4±0.02ms     4.0 MB/sec
linter/default-rules/large/dataset.py      1.00      6.5±0.05ms     6.2 MB/sec    1.01      6.6±0.04ms     6.1 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1444.5±4.93µs    11.5 MB/sec    1.01   1459.6±9.53µs    11.4 MB/sec
linter/default-rules/numpy/globals.py      1.01    168.7±0.37µs    17.5 MB/sec    1.00    167.0±4.92µs    17.7 MB/sec
linter/default-rules/pydantic/types.py     1.00      2.9±0.01ms     8.7 MB/sec    1.00      3.0±0.02ms     8.6 MB/sec

Windows

group                                      main                                    pr
-----                                      ----                                    --
formatter/large/dataset.py                 1.02      5.0±0.31ms     8.1 MB/sec     1.00      4.9±0.21ms     8.3 MB/sec
formatter/numpy/ctypeslib.py               1.00   935.5±38.59µs    17.8 MB/sec     1.01   942.2±33.26µs    17.7 MB/sec
formatter/numpy/globals.py                 1.00     90.0±3.75µs    32.8 MB/sec     1.05     94.4±5.75µs    31.2 MB/sec
formatter/pydantic/types.py                1.00  1899.3±102.37µs    13.4 MB/sec    1.02  1936.6±87.20µs    13.2 MB/sec
linter/all-rules/large/dataset.py          1.00     15.1±0.42ms     2.7 MB/sec     1.01     15.4±0.42ms     2.7 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      4.2±0.16ms     4.0 MB/sec     1.00      4.2±0.12ms     4.0 MB/sec
linter/all-rules/numpy/globals.py          1.00   528.6±19.07µs     5.6 MB/sec     1.03   542.0±19.54µs     5.4 MB/sec
linter/all-rules/pydantic/types.py         1.01      7.9±0.21ms     3.2 MB/sec     1.00      7.8±0.16ms     3.3 MB/sec
linter/default-rules/large/dataset.py      1.00      8.4±0.17ms     4.9 MB/sec     1.00      8.3±0.23ms     4.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.03  1830.4±48.47µs     9.1 MB/sec     1.00  1772.1±47.46µs     9.4 MB/sec
linter/default-rules/numpy/globals.py      1.00    223.5±7.08µs    13.2 MB/sec     1.03    229.2±9.25µs    12.9 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.8±0.11ms     6.7 MB/sec     1.00      3.8±0.09ms     6.7 MB/sec

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