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

Update mkdocs unformatted example error message #4312

Merged
merged 1 commit into from
May 9, 2023

Conversation

calumy
Copy link
Contributor

@calumy calumy commented May 9, 2023

In #3979 it became clear that the error message could be clearer that only the example section of the documentation should be updated. This PR clarifies this.

@charliermarsh charliermarsh changed the title Update mkdocs unformaged example error message Update mkdocs unformatted example error message May 9, 2023
@charliermarsh charliermarsh merged commit 8dea47a into astral-sh:main May 9, 2023
@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label May 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 9, 2023

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.01     13.9±0.03ms     2.9 MB/sec    1.00     13.8±0.03ms     2.9 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.3±0.00ms     5.0 MB/sec    1.00      3.3±0.01ms     5.0 MB/sec
linter/all-rules/numpy/globals.py          1.00    413.4±0.74µs     7.1 MB/sec    1.00    411.5±0.68µs     7.2 MB/sec
linter/all-rules/pydantic/types.py         1.00      5.8±0.01ms     4.4 MB/sec    1.00      5.8±0.01ms     4.4 MB/sec
linter/default-rules/large/dataset.py      1.01      6.9±0.01ms     5.9 MB/sec    1.00      6.9±0.01ms     5.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01   1485.9±2.11µs    11.2 MB/sec    1.00   1475.5±1.95µs    11.3 MB/sec
linter/default-rules/numpy/globals.py      1.01    163.1±0.23µs    18.1 MB/sec    1.00    161.9±0.14µs    18.2 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.1±0.00ms     8.3 MB/sec    1.00      3.1±0.01ms     8.3 MB/sec
parser/large/dataset.py                    1.01      5.5±0.00ms     7.5 MB/sec    1.00      5.4±0.01ms     7.5 MB/sec
parser/numpy/ctypeslib.py                  1.01   1063.8±0.71µs    15.7 MB/sec    1.00   1057.2±2.00µs    15.8 MB/sec
parser/numpy/globals.py                    1.00    108.1±0.15µs    27.3 MB/sec    1.00    107.8±0.16µs    27.4 MB/sec
parser/pydantic/types.py                   1.01      2.3±0.00ms    11.0 MB/sec    1.00      2.3±0.00ms    11.1 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.01     23.9±1.02ms  1740.9 KB/sec    1.00     23.6±0.73ms  1764.8 KB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      5.8±0.18ms     2.9 MB/sec    1.00      5.8±0.21ms     2.9 MB/sec
linter/all-rules/numpy/globals.py          1.00   671.1±29.49µs     4.4 MB/sec    1.02   681.7±37.74µs     4.3 MB/sec
linter/all-rules/pydantic/types.py         1.00      9.8±0.36ms     2.6 MB/sec    1.02     10.0±0.42ms     2.5 MB/sec
linter/default-rules/large/dataset.py      1.00     11.7±0.42ms     3.5 MB/sec    1.01     11.8±0.34ms     3.4 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00      2.5±0.10ms     6.7 MB/sec    1.01      2.5±0.12ms     6.6 MB/sec
linter/default-rules/numpy/globals.py      1.00   284.1±12.60µs    10.4 MB/sec    1.03   293.1±16.98µs    10.1 MB/sec
linter/default-rules/pydantic/types.py     1.01      5.3±0.19ms     4.9 MB/sec    1.00      5.2±0.19ms     4.9 MB/sec
parser/large/dataset.py                    1.00      9.6±0.31ms     4.2 MB/sec    1.01      9.7±0.29ms     4.2 MB/sec
parser/numpy/ctypeslib.py                  1.00  1829.7±58.80µs     9.1 MB/sec    1.00  1836.0±53.77µs     9.1 MB/sec
parser/numpy/globals.py                    1.00   186.7±12.08µs    15.8 MB/sec    1.00    187.0±8.61µs    15.8 MB/sec
parser/pydantic/types.py                   1.01      4.1±0.18ms     6.1 MB/sec    1.00      4.1±0.28ms     6.2 MB/sec

@calumy calumy deleted the update-docs-error 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