mirror of
https://github.com/openai/codex.git
synced 2026-04-28 00:25:56 +00:00
Apply argument comment lint across codex-rs (#14652)
## Why Once the repo-local lint exists, `codex-rs` needs to follow the checked-in convention and CI needs to keep it from drifting. This commit applies the fallback `/*param*/` style consistently across existing positional literal call sites without changing those APIs. The longer-term preference is still to avoid APIs that require comments by choosing clearer parameter types and call shapes. This PR is intentionally the mechanical follow-through for the places where the existing signatures stay in place. After rebasing onto newer `main`, the rollout also had to cover newly introduced `tui_app_server` call sites. That made it clear the first cut of the CI job was too expensive for the common path: it was spending almost as much time installing `cargo-dylint` and re-testing the lint crate as a representative test job spends running product tests. The CI update keeps the full workspace enforcement but trims that extra overhead from ordinary `codex-rs` PRs. ## What changed - keep a dedicated `argument_comment_lint` job in `rust-ci` - mechanically annotate remaining opaque positional literals across `codex-rs` with exact `/*param*/` comments, including the rebased `tui_app_server` call sites that now fall under the lint - keep the checked-in style aligned with the lint policy by using `/*param*/` and leaving string and char literals uncommented - cache `cargo-dylint`, `dylint-link`, and the relevant Cargo registry/git metadata in the lint job - split changed-path detection so the lint crate's own `cargo test` step runs only when `tools/argument-comment-lint/*` or `rust-ci.yml` changes - continue to run the repo wrapper over the `codex-rs` workspace, so product-code enforcement is unchanged Most of the code changes in this commit are intentionally mechanical comment rewrites or insertions driven by the lint itself. ## Verification - `./tools/argument-comment-lint/run.sh --workspace` - `cargo test -p codex-tui-app-server -p codex-tui` - parsed `.github/workflows/rust-ci.yml` locally with PyYAML --- * -> #14652 * #14651
This commit is contained in:
@@ -25,8 +25,8 @@ pub mod zsh_fork;
|
||||
|
||||
#[ctor]
|
||||
fn enable_deterministic_unified_exec_process_ids_for_tests() {
|
||||
codex_core::test_support::set_thread_manager_test_mode(true);
|
||||
codex_core::test_support::set_deterministic_process_ids(true);
|
||||
codex_core::test_support::set_thread_manager_test_mode(/*enabled*/ true);
|
||||
codex_core::test_support::set_deterministic_process_ids(/*enabled*/ true);
|
||||
}
|
||||
|
||||
#[ctor]
|
||||
@@ -79,7 +79,7 @@ pub fn test_path_buf_with_windows(unix_path: &str, windows_path: Option<&str>) -
|
||||
}
|
||||
|
||||
pub fn test_path_buf(unix_path: &str) -> PathBuf {
|
||||
test_path_buf_with_windows(unix_path, None)
|
||||
test_path_buf_with_windows(unix_path, /*windows_path*/ None)
|
||||
}
|
||||
|
||||
pub fn test_absolute_path_with_windows(
|
||||
@@ -91,7 +91,7 @@ pub fn test_absolute_path_with_windows(
|
||||
}
|
||||
|
||||
pub fn test_absolute_path(unix_path: &str) -> AbsolutePathBuf {
|
||||
test_absolute_path_with_windows(unix_path, None)
|
||||
test_absolute_path_with_windows(unix_path, /*windows_path*/ None)
|
||||
}
|
||||
|
||||
pub fn test_tmp_path() -> AbsolutePathBuf {
|
||||
@@ -264,7 +264,7 @@ pub fn sandbox_network_env_var() -> &'static str {
|
||||
}
|
||||
|
||||
pub fn format_with_current_shell(command: &str) -> Vec<String> {
|
||||
codex_core::shell::default_user_shell().derive_exec_args(command, true)
|
||||
codex_core::shell::default_user_shell().derive_exec_args(command, /*use_login_shell*/ true)
|
||||
}
|
||||
|
||||
pub fn format_with_current_shell_display(command: &str) -> String {
|
||||
@@ -273,7 +273,8 @@ pub fn format_with_current_shell_display(command: &str) -> String {
|
||||
}
|
||||
|
||||
pub fn format_with_current_shell_non_login(command: &str) -> Vec<String> {
|
||||
codex_core::shell::default_user_shell().derive_exec_args(command, false)
|
||||
codex_core::shell::default_user_shell()
|
||||
.derive_exec_args(command, /*use_login_shell*/ false)
|
||||
}
|
||||
|
||||
pub fn format_with_current_shell_display_non_login(command: &str) -> String {
|
||||
|
||||
Reference in New Issue
Block a user