pyo3/tests/test_macro_docs.rs

39 lines
866 B
Rust
Raw Normal View History

#![cfg(feature = "macros")]
use pyo3::prelude::*;
use pyo3::types::IntoPyDict;
#[macro_use]
2023-09-24 12:34:53 +00:00
#[path = "../src/tests/common.rs"]
mod common;
#[pyclass]
/// The MacroDocs class.
#[doc = concat!("Some macro ", "class ", "docs.")]
/// A very interesting type!
struct MacroDocs {}
#[pymethods]
impl MacroDocs {
#[doc = concat!("A macro ", "example.")]
/// With mixed doc types.
fn macro_doc(&self) {}
}
#[test]
fn meth_doc() {
Python::with_gil(|py| {
let d = [("C", py.get_type_bound::<MacroDocs>())].into_py_dict_bound(py);
py_assert!(
py,
*d,
"C.__doc__ == 'The MacroDocs class.\\nSome macro class docs.\\nA very interesting type!'"
);
py_assert!(
py,
*d,
"C.macro_doc.__doc__ == 'A macro example.\\nWith mixed doc types.'"
);
});
}