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 remaining pep8-naming docs #4149

Merged
merged 4 commits into from
Apr 29, 2023
Merged

Conversation

calumy
Copy link
Contributor

@calumy calumy commented Apr 29, 2023

Adds the remaining documentation for the pep8-naming rules.

Related to #2646.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 29, 2023

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     14.8±0.01ms     2.8 MB/sec    1.00     14.7±0.01ms     2.8 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.6±0.00ms     4.6 MB/sec    1.00      3.6±0.00ms     4.6 MB/sec
linter/all-rules/numpy/globals.py          1.00    372.3±0.94µs     7.9 MB/sec    1.01    374.2±0.90µs     7.9 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.2±0.01ms     4.1 MB/sec    1.00      6.2±0.01ms     4.1 MB/sec
linter/default-rules/large/dataset.py      1.01      7.6±0.01ms     5.4 MB/sec    1.00      7.5±0.01ms     5.4 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1578.4±3.36µs    10.5 MB/sec    1.00   1571.4±2.73µs    10.6 MB/sec
linter/default-rules/numpy/globals.py      1.01    171.1±0.34µs    17.2 MB/sec    1.00    169.4±0.25µs    17.4 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.4±0.00ms     7.5 MB/sec    1.00      3.4±0.01ms     7.6 MB/sec
parser/large/dataset.py                    1.00      5.9±0.00ms     6.9 MB/sec    1.01      5.9±0.01ms     6.9 MB/sec
parser/numpy/ctypeslib.py                  1.00   1147.6±2.47µs    14.5 MB/sec    1.00   1150.4±2.80µs    14.5 MB/sec
parser/numpy/globals.py                    1.00    116.8±0.23µs    25.3 MB/sec    1.00    117.1±0.27µs    25.2 MB/sec
parser/pydantic/types.py                   1.00      2.5±0.00ms    10.2 MB/sec    1.00      2.5±0.00ms    10.2 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.01     16.3±0.09ms     2.5 MB/sec    1.00     16.2±0.14ms     2.5 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      4.1±0.04ms     4.0 MB/sec    1.00      4.1±0.05ms     4.1 MB/sec
linter/all-rules/numpy/globals.py          1.00   490.4±12.07µs     6.0 MB/sec    1.00    491.7±5.71µs     6.0 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.9±0.06ms     3.7 MB/sec    1.00      6.9±0.06ms     3.7 MB/sec
linter/default-rules/large/dataset.py      1.02      8.4±0.06ms     4.8 MB/sec    1.00      8.3±0.05ms     4.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.02  1786.3±21.68µs     9.3 MB/sec    1.00  1759.7±18.49µs     9.5 MB/sec
linter/default-rules/numpy/globals.py      1.00    202.8±3.92µs    14.5 MB/sec    1.00    202.7±7.06µs    14.6 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.8±0.03ms     6.7 MB/sec    1.00      3.7±0.04ms     6.8 MB/sec
parser/large/dataset.py                    1.00      6.7±0.04ms     6.1 MB/sec    1.00      6.7±0.04ms     6.1 MB/sec
parser/numpy/ctypeslib.py                  1.00  1275.7±11.97µs    13.1 MB/sec    1.01  1285.4±11.33µs    13.0 MB/sec
parser/numpy/globals.py                    1.00    131.4±2.99µs    22.5 MB/sec    1.00    131.5±2.06µs    22.4 MB/sec
parser/pydantic/types.py                   1.00      2.8±0.02ms     9.0 MB/sec    1.01      2.9±0.02ms     8.9 MB/sec

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Apr 29, 2023
@charliermarsh charliermarsh merged commit 8f61eae into astral-sh:main Apr 29, 2023
@charliermarsh charliermarsh changed the title Add remaining pep8-naming docs Add remaining pep8-naming docs Apr 29, 2023
@calumy calumy deleted the pep8-naming-docs branch May 10, 2023 14:55
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