Document that the doctest
crate might need updating (#338)
Also rename the "Examples" build to "Doctest" to clarify what it does.
This commit is contained in:
parent
e6787cd621
commit
d04a2c6a01
2 changed files with 5 additions and 2 deletions
4
.github/workflows/ci.yml
vendored
4
.github/workflows/ci.yml
vendored
|
@ -61,8 +61,8 @@ jobs:
|
|||
- name: Check Clippy
|
||||
run: cd docs && cargo clippy --all-targets -- -D warnings
|
||||
|
||||
examples:
|
||||
name: Examples
|
||||
doctest:
|
||||
name: Doctest
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
|
|
|
@ -6,10 +6,13 @@ Great to see that you want to help out! Here are some tips for getting started:
|
|||
|
||||
* Most contributions should include [tests] and a [changelog entry].
|
||||
|
||||
* If you're adding or updating a web framework integration, you might need to update the [doctest crate].
|
||||
|
||||
* Want to work on documentation? See the [docs readme] for advice on that.
|
||||
|
||||
Have fun! ☺️
|
||||
|
||||
[tests]: maud/tests
|
||||
[changelog entry]: CHANGELOG.md
|
||||
[doctest crate]: doctest/Cargo.toml
|
||||
[docs readme]: docs/README.md
|
||||
|
|
Loading…
Add table
Reference in a new issue