From 275da9d943750598e4ed95769a89cc53e4afa7cb Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 18 Jul 2024 09:37:27 -0500 Subject: [PATCH] docs: reformat link to ledger headers in `events.rs` (#1468) For better appearance in the CLI, and to still work with MDX v3, this change removes the link definition, in favor of the bare URL. I'm also adding a macro for clippy to ignore the "improper markdown" in this comment. --- FULL_HELP_DOCS.md | 4 +--- cmd/soroban-cli/src/commands/events.rs | 6 +++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index e2b310aea..61766e3f0 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -627,9 +627,7 @@ Watch the network for contract events ###### **Options:** -* `--start-ledger ` — The first [ledger sequence] number in the range to pull events - - [ledger sequence]: https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence +* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence * `--cursor ` — The cursor corresponding to the start of the event range * `--output ` — Output formatting options for event stream diff --git a/cmd/soroban-cli/src/commands/events.rs b/cmd/soroban-cli/src/commands/events.rs index 63bdfa04d..e1013eada 100644 --- a/cmd/soroban-cli/src/commands/events.rs +++ b/cmd/soroban-cli/src/commands/events.rs @@ -12,9 +12,9 @@ use crate::rpc; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { - /// The first [ledger sequence] number in the range to pull events - /// - /// [ledger sequence]: https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence + #[allow(clippy::doc_markdown)] + /// The first ledger sequence number in the range to pull events + /// https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence #[arg(long, conflicts_with = "cursor", required_unless_present = "cursor")] start_ledger: Option, /// The cursor corresponding to the start of the event range.