Skip to content

Fix documentation referencing macro var#623

Merged
sanket1729 merged 1 commit intorust-bitcoin:masterfrom
RCasatta:fixdoc
Aug 13, 2021
Merged

Fix documentation referencing macro var#623
sanket1729 merged 1 commit intorust-bitcoin:masterfrom
RCasatta:fixdoc

Conversation

@RCasatta
Copy link
Copy Markdown
Collaborator

Current docs https://docs.rs/bitcoin/0.26.2/bitcoin/util/taproot/index.html show [$newtype] because macro vars aren't expanded in docs

Copy link
Copy Markdown
Collaborator

@Kixunil Kixunil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Collaborator

@dr-orlovsky dr-orlovsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Feel free to ignore my Nit and merge PR once there will be a second ACK

Comment on lines +54 to +56
#[doc = "The tag used for ["]
#[doc = $sname]
#[doc = "]"]
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: we need `` for formatting

Suggested change
#[doc = "The tag used for ["]
#[doc = $sname]
#[doc = "]"]
#[doc = "The tag used for [`"]
#[doc = $sname]
#[doc = "`]"]

@dr-orlovsky dr-orlovsky added this to the 0.28.0 milestone Aug 9, 2021
Copy link
Copy Markdown
Member

@sanket1729 sanket1729 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 8f27579

@sanket1729 sanket1729 merged commit bd5d875 into rust-bitcoin:master Aug 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants