From 78f427ddb34dc0d9d56798547d20cc583f5b1e56 Mon Sep 17 00:00:00 2001 From: Colin Snover Date: Sun, 28 Aug 2022 12:38:58 -0500 Subject: [PATCH] Improve links in docs for generated named arguments structs Probably needs https://github.com/rust-lang/rust/issues/74563 for the original intended behaviour. --- binrw_derive/src/codegen/typed_builder.rs | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/binrw_derive/src/codegen/typed_builder.rs b/binrw_derive/src/codegen/typed_builder.rs index b935f2ab..96963b44 100644 --- a/binrw_derive/src/codegen/typed_builder.rs +++ b/binrw_derive/src/codegen/typed_builder.rs @@ -48,14 +48,16 @@ impl<'a> Builder<'a> { let res_struct = if define_result { let docs = self.owner_name.map(|owner_name| { + let (impl_name, impl_fn) = if self.is_write { + ("BinWrite", "write_options") + } else { + ("BinRead", "read_options") + }; format!( - "Named arguments for [`{}::{}`].", + "Named arguments for the [`{0}::{1}`](::binrw::{0}::{1}) implementation of [`{2}`].", + impl_name, + impl_fn, owner_name, - if self.is_write { - "write_options" - } else { - "read_options" - } ) });