Check crate docs in CI

This commit is contained in:
Laurenz 2023-05-20 10:48:25 +02:00
parent 10fac14341
commit 7bb69c0902
3 changed files with 9 additions and 7 deletions

View File

@ -3,6 +3,7 @@ on: [push, pull_request]
env:
RUSTFLAGS: "-Dwarnings"
RUSTDOCFLAGS: "-Dwarnings"
jobs:
tests:
@ -16,14 +17,15 @@ jobs:
- run: cargo test --workspace --no-fail-fast
checks:
name: Check formatting and clippy
name: Check clippy, formatting, and documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- run: cargo fmt --check --all
- run: cargo clippy --workspace --all-targets
- run: cargo fmt --check --all
- run: cargo doc --workspace --no-deps
min-version:
name: Check mininum Rust version

View File

@ -134,7 +134,7 @@ impl ShapedGlyph {
matches!(self.c, '《' | '' | '『' | '「')
}
/// See https://www.w3.org/TR/clreq/#punctuation_width_adjustment
/// See <https://www.w3.org/TR/clreq/#punctuation_width_adjustment>
pub fn is_cjk_center_aligned_punctuation(&self, gb_style: bool) -> bool {
if !gb_style && matches!(self.c, '' | '。' | '、' | '' | '') {
return true;

View File

@ -14,12 +14,12 @@ Top level directory structure:
## Running the tests
Running all tests (including unit tests):
```bash
cargo test --all
cargo test --workspace
```
Running just the integration tests (the tests in this directory):
```bash
cargo test --all --test tests
cargo test --workspace --test tests
```
You may want to [make yourself an alias](#making-an-alias) like:
@ -73,13 +73,13 @@ testit empty.typ
### Bash
Open your Bash configuration by executing `nano ~/.bashrc`.
```bash
alias testit="cargo test --all --test tests --"
alias testit="cargo test --workspace --test tests --"
```
### PowerShell
Open your PowerShell profile by executing `notepad $profile`.
```ps
function testit {
cargo test --all --test tests -- $args
cargo test --workspace --test tests -- $args
}
```