Merge rust-bitcoin/rust-bitcoin#3536: Use `doc(notable_trait)`

dfb76c1e15 Use doc(notable_trait) (Tobin C. Harding)

Pull request description:

  There is an unstable feature that puts up a little 'i' in a circle next to any function that returns a type that implements an notable trait. For us this means we can make the extension traits more discoverable.

  ref: https://doc.rust-lang.org/unstable-book/language-features/doc-notable-trait.html

  Close: #3232

ACKs for top commit:
  apoelstra:
    ACK dfb76c1e15933fe0058c1bb69c4b1b9acddceee8; successfully ran local tests

Tree-SHA512: 0fbc7a2a3c8c499a9276d1e86b9966a7ae6bd8a354aff5fd40aa11d07945db589b2a9c2cdfa43ddadfafcee706ae7f68cedc269f74622643307cc43cd07d554f
This commit is contained in:
merge-script 2024-10-31 15:01:19 +00:00
commit 5f3af4bab2
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
2 changed files with 2 additions and 0 deletions

View File

@ -252,6 +252,7 @@ macro_rules! define_extension_trait {
fn $fn:ident$(<$($gen:ident: $gent:path),*>)?($($params:tt)*) $( -> $ret:ty )? $body:block
)*
}) => {
#[cfg_attr(docsrs, doc(notable_trait))]
$(#[$($trait_attrs)*])* $trait_vis trait $trait_name: sealed::Sealed {
$(
$crate::internal_macros::only_doc_attrs! {

View File

@ -27,6 +27,7 @@
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
// Experimental features we need.
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(docsrs, feature(doc_notable_trait))]
#![cfg_attr(bench, feature(test))]
// Coding conventions.
#![warn(missing_docs)]