docs: fix rustdoc release warnings

This commit is contained in:
Hunter Bown
2026-04-26 23:43:31 -05:00
parent bb3c460358
commit e8c3e7d1bf
3 changed files with 5 additions and 4 deletions
+1 -1
View File
@@ -1300,7 +1300,7 @@ impl App {
pub const QUIT_CONFIRMATION_WINDOW: Duration = Duration::from_secs(2);
/// Arm the quit confirmation timer. The next Ctrl+C within
/// [`QUIT_CONFIRMATION_WINDOW`] should exit the app cleanly. Call this only
/// [`Self::QUIT_CONFIRMATION_WINDOW`] should exit the app cleanly. Call this only
/// from idle state — while a turn is in flight or a modal is open Ctrl+C
/// retains its existing "interrupt this turn" / "close modal" semantics.
pub fn arm_quit(&mut self) {
+1 -1
View File
@@ -36,7 +36,7 @@ pub enum EditorOutcome {
}
/// Resolve the editor command, preferring `$VISUAL` over `$EDITOR`, falling
/// back to `vi`. Returns the raw string for the test path; [`spawn_editor`]
/// back to `vi`. Returns the raw string for the test path; `spawn_editor`
/// splits it via `shlex` (Unix) so users can set `EDITOR="code --wait"`.
fn resolve_editor() -> String {
env::var("VISUAL")
+3 -2
View File
@@ -9,9 +9,10 @@
//! recognise.
//!
//! See `codex-rs/tui/src/key_hint.rs` for the original design; this is a
//! ratatui-compatible port that exposes a [`Display`] impl plus a
//! ratatui-compatible port that exposes a [`std::fmt::Display`] impl plus a
//! `KeyBinding -> Span` conversion so call sites can use it equally well in
//! plain `format!` calls and inside ratatui [`Line`] / [`Span`] builders.
//! plain `format!` calls and inside ratatui [`ratatui::text::Line`] /
//! [`ratatui::text::Span`] builders.
//!
//! Windows AltGr disambiguation: many European keyboard layouts produce
//! `Ctrl+Alt` events when AltGr is pressed alone (to type `@`, `\`, etc.).