docs: add clarification on explainError and renderDiagnostic cycling

Author: Marc Jakobi

README.md

@@ -424,6 +424,10 @@ vim.keymap.set(
   vim.cmd.RustLsp('explainError')
   ```
 
+  Like `vim.diagnostic.goto_next`, `explainError` will cycle diagnostics,
+  starting at the cursor position, until it can find a diagnostic with
+  an error code.
+
 ![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/bac9b31c-22ca-40c4-bfd3-b8c5ba4cc49a)
 
 </details>
@@ -446,6 +450,10 @@ vim.keymap.set(
   vim.cmd.RustLsp('renderDiagnostic')
   ```
 
+  Like `vim.diagnostic.goto_next`, `renderDiagnostic` will cycle diagnostics,
+  starting at the cursor position, until it can find a diagnostic with
+  rendered data.
+
 ![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/a972c6b6-c504-4c2a-8380-53451bb8c2de)
 
 </details>

doc/rustaceanvim.txt

@@ -42,8 +42,14 @@ It accepts the following subcommands:
  'moveItem {up|down}' - Move items up or down.
  'hover {actions|range}' - Hover actions, or hover over visually selected range.
  'explainError' - Display a hover window with explanations form the Rust error index.
+                  Like |vim.diagnostic.goto_next|, |explainError| will cycle diagnostics,
+                  starting at the cursor position, until it can find a diagnostic with
+                  an error code.
  'renderDiagnostic' - Display a hover window with the rendered diagnostic,
                       as displayed during `cargo build`.
+                  Like |vim.diagnostic.goto_next|, |renderDiagnostic| will cycle diagnostics,
+                  starting at the cursor position, until it can find a diagnostic with
+                  rendered data.
  'openCargo' - Open the Cargo.toml file for the current package.
  'openDocs' - Open docs.rs documentation for the symbol under the cursor.
  'parentModule' - Open the current module's parent module.

lua/rustaceanvim/init.lua

@@ -35,8 +35,14 @@
 --- 'moveItem {up|down}' - Move items up or down.
 --- 'hover {actions|range}' - Hover actions, or hover over visually selected range.
 --- 'explainError' - Display a hover window with explanations form the Rust error index.
+---                  Like |vim.diagnostic.goto_next|, |explainError| will cycle diagnostics,
+---                  starting at the cursor position, until it can find a diagnostic with
+---                  an error code.
 --- 'renderDiagnostic' - Display a hover window with the rendered diagnostic,
 ---                      as displayed during `cargo build`.
+---                  Like |vim.diagnostic.goto_next|, |renderDiagnostic| will cycle diagnostics,
+---                  starting at the cursor position, until it can find a diagnostic with
+---                  rendered data.
 --- 'openCargo' - Open the Cargo.toml file for the current package.
 --- 'openDocs' - Open docs.rs documentation for the symbol under the cursor.
 --- 'parentModule' - Open the current module's parent module.