Skip to content

Commit

Permalink
docs: reformat link to ledger headers in events.rs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ElliotFriend committed Jul 17, 2024
1 parent 2d72179 commit 202c6b3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
4 changes: 1 addition & 3 deletions FULL_HELP_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -627,9 +627,7 @@ Watch the network for contract events

###### **Options:**

* `--start-ledger <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 <START_LEDGER>` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/encyclopedia/ledger-headers#ledger-sequence
* `--cursor <CURSOR>` — The cursor corresponding to the start of the event range
* `--output <OUTPUT>` — Output formatting options for event stream

Expand Down
6 changes: 3 additions & 3 deletions cmd/soroban-cli/src/commands/events.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<u32>,
/// The cursor corresponding to the start of the event range.
Expand Down

0 comments on commit 202c6b3

Please sign in to comment.