Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 #449.
waywardmonkeys marked this conversation as resolved.
Show resolved Hide resolved
clippy.doc_markdown = "warn"
clippy.fn_to_numeric_cast_any = "forbid"
clippy.infinite_loop = "warn"
clippy.large_include_file = "warn"
Expand Down
2 changes: 2 additions & 0 deletions masonry/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@
//! [Druid]: https://crates.io/crates/druid
//! [Xilem]: https://crates.io/crates/xilem

// TODO: #449: Remove this once the issues within masonry are fixed.
waywardmonkeys marked this conversation as resolved.
Show resolved Hide resolved
#![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)]
Expand Down
2 changes: 1 addition & 1 deletion xilem/examples/calc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion xilem_core/src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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:?}");
Expand Down
2 changes: 1 addition & 1 deletion xilem_core/tests/one_of.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down