Skip to content

Commit

Permalink
Link mermaid docs to crate that uses them (paritytech#3087)
Browse files Browse the repository at this point in the history
While including files cross crate works locally. When pushed to
crates.io each crate is seperate so the file path no longer exists.

Instead change it to a symlink, which cargo will change to a read
directory when published.
  • Loading branch information
Morganamilo authored Jan 29, 2024
1 parent 5cb7a69 commit a63c01d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions substrate/primitives/runtime/docs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ type UncheckedSignaturePayload<Address, Signature, Extra> = (Address, Signature,
/// could in principle be any other interaction. Transactions are either signed or unsigned. A
/// sensible transaction pool should ensure that only transactions that are worthwhile are
/// considered for block-building.
#[cfg_attr(feature = "std", doc = simple_mermaid::mermaid!("../../../../../docs/mermaid/extrinsics.mmd"))]
#[cfg_attr(feature = "std", doc = simple_mermaid::mermaid!("../../docs/mermaid/extrinsics.mmd"))]
/// This type is by no means enforced within Substrate, but given its genericness, it is highly
/// likely that for most use-cases it will suffice. Thus, the encoding of this type will dictate
/// exactly what bytes should be sent to a runtime to transact with it.
Expand Down

0 comments on commit a63c01d

Please sign in to comment.