From 62d000f7cb8c5dc7c8be482fc1e3a81b4efa6689 Mon Sep 17 00:00:00 2001 From: Fintan Halpenny Date: Thu, 16 Jan 2025 11:04:31 +0000 Subject: [PATCH] radicle: fix `parse_ref_*` documentation The `parse_ref` and `parse_ref_namespaced` documentation used 4 space indentation for the reference names. Unfortunately, `cargo test` attempts to interpret this as code. Use triple-backtick code fencing, with `text` and `no_run`, instead. --- radicle/src/git.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/radicle/src/git.rs b/radicle/src/git.rs index 5caff29b..0d202e6f 100644 --- a/radicle/src/git.rs +++ b/radicle/src/git.rs @@ -446,7 +446,9 @@ pub fn remote_refs(url: &Url) -> Result, ListRefsError /// e.g. in the reference below, the segment is /// `z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C`: /// -/// refs/namespaces/z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C/refs/heads/main +/// ```text, no_run +/// refs/namespaces/z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C/refs/heads/main +/// ``` /// /// The `T` can be specified when calling the function. For example, if you /// wanted to parse the namespace as a `PublicKey`, then you would the function @@ -473,7 +475,9 @@ where /// e.g. in the reference below, the segment is /// `z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C`: /// -/// refs/namespaces/z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C/refs/heads/main +/// ```text, no_run +/// refs/namespaces/z6MkvUJtYD9dHDJfpevWRT98mzDDpdAtmUjwyDSkyqksUr7C/refs/heads/main +/// ``` /// /// The `T` can be specified when calling the function. For example, if you /// wanted to parse the namespace as a `PublicKey`, then you would the function