From 1dcda8809d8de42670a55d39b7ccbe2ef412dead Mon Sep 17 00:00:00 2001 From: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Date: Thu, 4 Mar 2021 19:41:11 +0000 Subject: [PATCH] docs: deny warnings in ci --- .github/workflows/ci.yml | 1 + guide/src/class/protocols.md | 2 +- src/class/impl_.rs | 2 +- src/derive_utils.rs | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1fa0a212..a2a83e6a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -141,6 +141,7 @@ jobs: CARGO_BUILD_TARGET: ${{ matrix.platform.rust-target }} RUST_BACKTRACE: 1 RUSTFLAGS: "-D warnings" + RUSTDOCFLAGS: "-D warnings" # TODO: this is a hack to workaround compile_error! warnings about auto-initialize on PyPy # Once cargo's `resolver = "2"` is stable (~ MSRV Rust 1.52), remove this. PYO3_CI: 1 diff --git a/guide/src/class/protocols.md b/guide/src/class/protocols.md index f0098abb..31c33d9a 100644 --- a/guide/src/class/protocols.md +++ b/guide/src/class/protocols.md @@ -299,5 +299,5 @@ In Python a generator can also return a value. To express this in Rust, PyO3 pro both `Yield` values and `Return` a final value - see its docs for further details and an example. [`PyGCProtocol`]: https://docs.rs/pyo3/latest/pyo3/class/gc/trait.PyGCProtocol.html -[`PyGCProtocol`]: https://docs.rs/pyo3/latest/pyo3/class/number/trait.PyNumberProtocol.html +[`PyNumberProtocol`]: https://docs.rs/pyo3/latest/pyo3/class/number/trait.PyNumberProtocol.html [`PyObjectProtocol`]: https://docs.rs/pyo3/latest/pyo3/class/basic/trait.PyObjectProtocol.html diff --git a/src/class/impl_.rs b/src/class/impl_.rs index 41bfd16f..231d4309 100644 --- a/src/class/impl_.rs +++ b/src/class/impl_.rs @@ -4,7 +4,7 @@ use crate::{derive_utils::PyBaseTypeUtils, ffi, PyMethodDefType, PyNativeType}; use std::{marker::PhantomData, thread}; /// This type is used as a "dummy" type on which dtolnay specializations are -/// applied to apply implementations from #[pymethods] & #[pyproto] +/// applied to apply implementations from `#[pymethods]` & `#[pyproto]` pub struct PyClassImplCollector(PhantomData); impl PyClassImplCollector { diff --git a/src/derive_utils.rs b/src/derive_utils.rs index 5b2525d9..1dec6fab 100644 --- a/src/derive_utils.rs +++ b/src/derive_utils.rs @@ -19,7 +19,7 @@ pub struct KeywordOnlyParameterDescription { pub required: bool, } -/// Function argument specification for a #[pyfunction] or #[pymethod]. +/// Function argument specification for a `#[pyfunction]` or `#[pymethod]`. #[derive(Debug)] pub struct FunctionDescription { pub fname: &'static str,