mirror of
https://github.com/openai/codex.git
synced 2026-11-01 19:33:35 +00:00
docs: document all of the tui/tui2 and some other stuff
Automated pass; details in docs/documentation-pass.md and docs/documentation-status.md.
This commit is contained in:
@@ -8,7 +8,7 @@ use crate::openai_models::ReasoningEffort;
|
||||
|
||||
/// A summary of the reasoning performed by the model. This can be useful for
|
||||
/// debugging and understanding the model's reasoning process.
|
||||
/// See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#reasoning-summaries
|
||||
/// See <https://platform.openai.com/docs/guides/reasoning?api-mode=responses#reasoning-summaries>
|
||||
#[derive(
|
||||
Debug, Serialize, Deserialize, Default, Clone, Copy, PartialEq, Eq, Display, JsonSchema, TS,
|
||||
)]
|
||||
@@ -103,7 +103,7 @@ pub enum TrustLevel {
|
||||
/// that alternate screen buffers should not have scrollback.
|
||||
///
|
||||
/// **Zellij's behavior:** Zellij intentionally disables scrollback in alternate screen mode
|
||||
/// (see https://github.com/zellij-org/zellij/pull/1032) to comply with the xterm spec. This
|
||||
/// (see <https://github.com/zellij-org/zellij/pull/1032>) to comply with the xterm spec. This
|
||||
/// is by design and not configurable in Zellij—there is no option to enable scrollback in
|
||||
/// alternate screen mode.
|
||||
///
|
||||
|
||||
@@ -11,7 +11,7 @@ use ts_rs::TS;
|
||||
|
||||
use crate::config_types::Verbosity;
|
||||
|
||||
/// See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning
|
||||
/// See <https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning>
|
||||
#[derive(
|
||||
Debug,
|
||||
Serialize,
|
||||
|
||||
@@ -89,7 +89,7 @@ pub enum Op {
|
||||
},
|
||||
|
||||
/// Similar to [`Op::UserInput`], but contains additional context required
|
||||
/// for a turn of a [`crate::codex_thread::CodexThread`].
|
||||
/// for a turn of a `CodexThread`.
|
||||
UserTurn {
|
||||
/// User input items, see `InputItem`
|
||||
items: Vec<UserInput>,
|
||||
|
||||
Reference in New Issue
Block a user