Skip to content

Commit 429325e

Browse files
authored
Run 'make check' on the CI (#833)
1 parent f7932ff commit 429325e

File tree

5 files changed

+28
-33
lines changed

5 files changed

+28
-33
lines changed

.github/workflows/ci.yml

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,26 @@
11
name: Tests
22

3-
on:
4-
pull_request:
5-
push:
6-
branches: main
7-
workflow_dispatch:
3+
on: [pull_request, push, workflow_dispatch]
4+
5+
env:
6+
FORCE_COLOR: 1
87

98
jobs:
109
test:
11-
name: test w/ Python ${{ matrix.python-version }}
10+
name: test
1211

1312
runs-on: ubuntu-latest
1413

15-
strategy:
16-
matrix:
17-
python-version: ["3.10"]
18-
1914
steps:
20-
- uses: actions/checkout@v2
21-
- uses: actions/setup-python@v2
15+
- uses: actions/checkout@v3
16+
- uses: actions/setup-python@v3
2217
with:
23-
python-version: ${{ matrix.python-version }}
18+
python-version: "3.10"
2419
cache: pip
25-
- name: Install Dependencies
26-
run: python3 -m pip install -U pip -r requirements.txt
27-
- name: Build Docs
28-
run: sphinx-build --color -n -W -b html -d _build/doctrees . _build/html
29-
- name: Link Check
30-
run: sphinx-build --color -b linkcheck -d _build/doctrees . _build/linkcheck
20+
- name: Build docs
21+
run: make html
22+
- name: Check markup
23+
run: make check
24+
- name: Link check
25+
run: make linkcheck
3126
continue-on-error: true

compiler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ Emission of bytecode is handled by the following macros:
406406
just like ``ADDOP_O``, but name mangling is also handled; used for
407407
attribute loading or importing based on name
408408
``ADDOP_LOAD_CONST(struct compiler *, PyObject *)``
409-
add the `LOAD_CONST` opcode with the proper argument based on the
409+
add the ``LOAD_CONST`` opcode with the proper argument based on the
410410
position of the specified PyObject in the consts table.
411411
``ADDOP_LOAD_CONST_NEW(struct compiler *, PyObject *)``
412412
just like ``ADDOP_LOAD_CONST_NEW``, but steals a reference to PyObject

documenting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1572,8 +1572,8 @@ Using sphinx-build
15721572
------------------
15731573

15741574
Sometimes we directly want to execute the sphinx-build tool instead of through
1575-
`make` (although the latter is still the preferred way). In this case, you can
1576-
use the following command line from the `Doc` directory (make sure to install
1575+
``make`` (although the latter is still the preferred way). In this case, you can
1576+
use the following command line from the ``Doc`` directory (make sure to install
15771577
Sphinx_, blurb_ and python-docs-theme_ packages from PyPI)::
15781578

15791579
sphinx-build -b<builder> . build/<builder>

parser.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ Pegen has some special grammatical elements and rules:
570570
* Strings with single quotes (') (e.g. ``'class'``) denote KEYWORDS.
571571
* Strings with double quotes (") (e.g. ``"match"``) denote SOFT KEYWORDS.
572572
* Upper case names (e.g. ``NAME``) denote tokens in the :file:`Grammar/Tokens` file.
573-
* Rule names starting with `invalid_` are used for specialized syntax errors.
573+
* Rule names starting with ``invalid_`` are used for specialized syntax errors.
574574

575575
- These rules are NOT used in the first pass of the parser.
576576
- Only if the first pass fails to parse, a second pass including the invalid
@@ -611,7 +611,7 @@ As described previously, to avoid exponential time complexity in the parser, mem
611611
The C parser used by Python is highly optimized and memoization can be expensive both in memory and time. Although
612612
the memory cost is obvious (the parser needs memory for storing previous results in the cache) the execution time
613613
cost comes for continuously checking if the given rule has a cache hit or not. In many situations, just parsing it
614-
again can be faster. Pegen **disables memoization by default** except for rules with the special marker `memo` after
614+
again can be faster. Pegen **disables memoization by default** except for rules with the special marker ``memo`` after
615615
the rule name (and type, if present): ::
616616

617617
rule_name[typr] (memo):

tracker.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ Using the Issue Tracker
88
=======================
99

1010
If you think you have found a bug in Python, you can report it to the
11-
`issue tracker`_. The `issue tracker`_ is now hosted on Github, alongside
11+
`issue tracker`_. The `issue tracker`_ is now hosted on GitHub, alongside
1212
the codebase and pull requests. Documentation bugs can also be reported there.
1313

1414
If you would like to file an issue about this devguide, please do so at the
1515
`devguide repo`_.
1616

1717
.. note::
1818
Python used to use a dedicated `Roundup`_ instance as its issue tracker.
19-
That old bug tracker was hosted under the domain `bugs.python.org`
20-
(sometimes called `bpo` for short). Currently a read-only version is still
21-
available on that domain for historical purposes. All `bpo` data has been
22-
migrated to the current `issue tracker`_ on Github.
19+
That old bug tracker was hosted under the domain ``bugs.python.org``
20+
(sometimes called ``bpo`` for short). Currently a read-only version is still
21+
available on that domain for historical purposes. All ``bpo`` data has been
22+
migrated to the current `issue tracker`_ on GitHub.
2323

24-
If you're familiar with `bpo` and would like to learn more about Github
24+
If you're familiar with ``bpo`` and would like to learn more about GitHub
2525
issues, please read this page, and the :doc:`triaging` page as they
2626
provide good introductory material. There is also a :doc:`gh-faq`
2727
document to answer some of the more popular questions.
@@ -41,14 +41,14 @@ already been reported. Checking if the problem is an existing issue will:
4141

4242
To see if an issue already exists, search the bug database using the search box
4343
above the list of bugs on the issues page. A form-based `advanced search`_ query
44-
builder is also available on Github to help creating the text query you need.
44+
builder is also available on GitHub to help creating the text query you need.
4545

4646
Reporting an issue
4747
------------------
4848

4949
If the problem you're reporting is not already in the `issue tracker`_, you
5050
can report it using the green "New issue" button on the right of the search
51-
box above the list of bugs. If you're not already signed in to Github, it
51+
box above the list of bugs. If you're not already signed in to GitHub, it
5252
will ask you to do so now.
5353

5454
First you need to select what kind of problem you want to report. The
@@ -90,7 +90,7 @@ developers, this is covered in the :ref:`triaging` page. You don't need
9090
to worry about those when reporting issues as a Python user.
9191

9292
You will automatically receive an update each time an action is taken on
93-
the bug, unless you changed your Github notification settings.
93+
the bug, unless you changed your GitHub notification settings.
9494

9595

9696
Disagreement With a Resolution on the Issue Tracker

0 commit comments

Comments
 (0)