Cleanup

Author: peter-lyons-kehl

README.md

@@ -23,25 +23,19 @@ const unsafe fn unsafe_fn_one_arg(b: bool) -> bool { b }
 const unsafe fn unsafe_fn_two_args(_: bool, u: u8) -> u8 { u }
 
 const _: () = unsafe_fn!(unsafe_fn_no_args);
-const _: bool = unsafe_fn!(unsafe_fn_one_arg=> true);
-const _: u8 = unsafe_fn!(unsafe_fn_two_args=> true, 0);
-fn main() {}
+const _: bool = unsafe_fn!(unsafe_fn_one_arg => true);
+const _: u8 = unsafe_fn!(unsafe_fn_two_args => true, 0);
 ```
 
 ## unsafe_method
 
-### self by value
+### self is Copy, by value
 ```rust
 use prudent::unsafe_method;
 const _: u8 = unsafe_method!( 1u8 =>@ unchecked_add => 0 );
 ```
 
-```rust
-let _todo = ();
-//# use prudent::unsafe_method;
-//const _: u8 = unsafe_method!(~allow_unsafe ~expect_unsafe 1u8, unchecked_add, 0);
-```
-
+### self is not Copy, by shared reference
 ```rust
 use prudent::unsafe_method;
 struct SNonCopy {}
@@ -53,7 +47,6 @@ impl SNonCopy {
 
 fn main() {
     let s = SNonCopy {};
-    // Works ALSO for non-Copy types
     unsafe_method!(s =>@ unsafe_method_no_args);
     unsafe_method!(s =>@ unsafe_method_one_arg => true);
     unsafe_method!(s =>@ unsafe_method_two_args => true, false);

src/backend.rs

@@ -1,5 +1,5 @@
 //! "backend" functionality (anything else than linted macros)
-//! - a few macros macros; and
+//! - helper macro(s); and
 //! - any non-macro functionality.
 
 /// For casting/ensuring that a user-provided function is unsafe. Used by [crate::unsafe_fn].
@@ -269,8 +269,8 @@ pub const fn shared_to_mut<T>(_: &T) -> &'static mut T {
     unreachable!()
 }
 
-/// This is an "early" type check for [unsafe_val], so that the user knows to use [unsafe_val] with
-/// [core::marker::Copy] types only.
+/// This is an "early" type check for [crate::unsafe_val], so that the user knows to use
+/// [crate::unsafe_val] with [core::marker::Copy] types only.
 ///
 /// NOT a part of public API!
 #[doc(hidden)]

src/lib.rs

@@ -6,10 +6,12 @@
 //!   - macros inject code, so they are not as sandboxed/isolated as non-macro code.
 //! - Otherwise it's a pain to edit them/render them in VS Code. Yes, that matters.
 
-#![cfg_attr(
+/*#![cfg_attr(
     feature = "assert_unsafe_methods",
     doc(test(attr(feature(type_alias_impl_trait))))
-)]
+)]*/
+#![doc(test(attr(forbid(unexpected_cfgs))))]
+//
 #![allow(clippy::useless_attribute)]
 #![allow(clippy::needless_doctest_main)]
 #![cfg_attr(not(any(doc, test)), no_std)]