Enable `clippy::doc_markdown` for non-masonry crates. (#480)

Co-authored-by: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
This commit is contained in:
Bruce Mitchener 2024-08-02 14:42:36 +07:00 committed by GitHub
parent dd938d4af4
commit b35162b82e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 7 additions and 3 deletions

View File

@ -49,6 +49,8 @@ rust.variant_size_differences = "warn"
clippy.allow_attributes_without_reason = "warn"
clippy.collection_is_never_read = "warn"
clippy.debug_assert_with_mut_call = "warn"
# This is marked as `allow` within masonry due to https://github.com/linebender/xilem/issues/449.
clippy.doc_markdown = "warn"
clippy.fn_to_numeric_cast_any = "forbid"
clippy.infinite_loop = "warn"
clippy.large_include_file = "warn"

View File

@ -80,6 +80,8 @@
//! [Druid]: https://crates.io/crates/druid
//! [Xilem]: https://crates.io/crates/xilem
// TODO: Remove this once the issues within masonry are fixed. Tracked in https://github.com/linebender/xilem/issues/449
#![allow(rustdoc::broken_intra_doc_links, clippy::doc_markdown)]
#![deny(clippy::trivially_copy_pass_by_ref)]
// #![deny(rustdoc::broken_intra_doc_links)]
// #![warn(missing_docs)]

View File

@ -287,7 +287,7 @@ fn expanded_button(
}
/// Returns an expanded button that triggers the calculator's operator handler,
/// on_entered_operator().
/// `on_entered_operator()`.
fn operator_button(math_operator: MathOperator) -> impl WidgetView<Calculator> {
expanded_button(math_operator.as_str(), move |data: &mut Calculator| {
data.on_entered_operator(math_operator);

View File

@ -155,7 +155,7 @@ mod tests {
}
#[test]
/// DynMessage's debug should pass through the debug implementation of
/// `DynMessage`'s debug should pass through the debug implementation of
fn message_debug() {
let message: DynMessage = Box::new(MyMessage("".to_string()));
let debug_result = format!("{message:?}");

View File

@ -205,7 +205,7 @@ fn one_of_type_change_rebuild() {
}
#[test]
/// OneOf2 should successfully allow the child to teardown
/// `OneOf2` should successfully allow the child to teardown
fn one_of_passthrough_teardown() {
let view1: OneOf2<OperationView<0>, OperationView<1>> = OneOf2::A(record_ops_0(0));
let mut ctx = TestCtx::default();