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.

Sign up for GitHub

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

Jump to bottom

Document formatter progress scripts #6035

Merged
merged 1 commit into from
Jul 24, 2023
Merged

Document formatter progress scripts #6035

merged 1 commit into from
Jul 24, 2023

Conversation

konstin
Copy link
Member

@konstin konstin commented Jul 24, 2023

Summary

Add documentation to the formatter progress scripts

Test Plan

n/a

@konstin konstin added internal An internal refactor or improvement formatter Related to the formatter labels Jul 24, 2023
MichaReiser
MichaReiser approved these changes Jul 24, 2023
View reviewed changes
crates/ruff_python_formatter/README.md
formatting and our formatting. You could compute it as the number of neutral lines in a diff divided
by the neutral plus the removed lines. It also checks for common problems such unstable formatting,
internal formatter errors and printing invalid syntax. We run this script in CI and you can view the
results in a PR page under "Checks" > "CI" > "Summary" at the bottom of the page.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a good resource/reference for users to know whether the numbers are improving or regressing compared to main? I looked at the result at my other PR and wasn't sure against what I should compare the numbers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not really, but i'd rather solve the tracking-numbers-from-CI in general over building more CI-interacting script

@github-actions
Copy link
Contributor

PR Check Results

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.00      9.7±0.03ms     4.2 MB/sec    1.00      9.7±0.02ms     4.2 MB/sec
formatter/numpy/ctypeslib.py               1.00   1890.3±4.54µs     8.8 MB/sec    1.00   1897.2±4.29µs     8.8 MB/sec
formatter/numpy/globals.py                 1.00    206.4±2.18µs    14.3 MB/sec    1.01    208.0±2.39µs    14.2 MB/sec
formatter/pydantic/types.py                1.00      4.2±0.01ms     6.1 MB/sec    1.01      4.2±0.01ms     6.1 MB/sec
linter/all-rules/large/dataset.py          1.00     13.5±0.04ms     3.0 MB/sec    1.00     13.4±0.03ms     3.0 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.4±0.00ms     4.9 MB/sec    1.00      3.4±0.00ms     4.9 MB/sec
linter/all-rules/numpy/globals.py          1.00    363.0±0.87µs     8.1 MB/sec    1.00    363.3±1.18µs     8.1 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.1±0.04ms     4.2 MB/sec    1.00      6.1±0.02ms     4.2 MB/sec
linter/default-rules/large/dataset.py      1.00      7.1±0.02ms     5.7 MB/sec    1.00      7.1±0.02ms     5.7 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1430.0±2.57µs    11.6 MB/sec    1.01   1439.3±4.68µs    11.6 MB/sec
linter/default-rules/numpy/globals.py      1.00    151.1±0.45µs    19.5 MB/sec    1.00    151.0±0.41µs    19.5 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.2±0.01ms     8.1 MB/sec    1.00      3.2±0.01ms     8.1 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
formatter/large/dataset.py                 1.01     10.5±0.12ms     3.9 MB/sec    1.00     10.4±0.13ms     3.9 MB/sec
formatter/numpy/ctypeslib.py               1.00      2.0±0.04ms     8.2 MB/sec    1.01      2.0±0.08ms     8.1 MB/sec
formatter/numpy/globals.py                 1.00    229.3±7.93µs    12.9 MB/sec    1.04   237.3±14.98µs    12.4 MB/sec
formatter/pydantic/types.py                1.00      4.5±0.08ms     5.7 MB/sec    1.01      4.5±0.08ms     5.7 MB/sec
linter/all-rules/large/dataset.py          1.00     14.7±0.18ms     2.8 MB/sec    1.00     14.8±0.20ms     2.8 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.9±0.10ms     4.2 MB/sec    1.00      3.9±0.08ms     4.2 MB/sec
linter/all-rules/numpy/globals.py          1.00   462.0±14.30µs     6.4 MB/sec    1.01   466.7±31.23µs     6.3 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.9±0.11ms     3.7 MB/sec    1.00      6.8±0.13ms     3.7 MB/sec
linter/default-rules/large/dataset.py      1.00      7.7±0.08ms     5.3 MB/sec    1.01      7.8±0.08ms     5.2 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1584.4±26.54µs    10.5 MB/sec    1.01  1598.1±27.13µs    10.4 MB/sec
linter/default-rules/numpy/globals.py      1.00    178.8±3.92µs    16.5 MB/sec    1.01    180.4±5.19µs    16.4 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.4±0.05ms     7.5 MB/sec    1.00      3.4±0.05ms     7.4 MB/sec

@konstin konstin merged commit a9f5359 into main Jul 24, 2023
@konstin konstin deleted the document_formatter_progress_scripts branch July 24, 2023 17:42
@konstin konstin mentioned this pull request Jul 24, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MichaReiser MichaReiser MichaReiser approved these changes

Assignees
No one assigned
Labels
formatter Related to the formatter internal An internal refactor or improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@konstin @MichaReiser