codex_rust_crate docstring omits live macro parameters

Open Beginner friendly
#25,537 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
86/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust

Research direction

Open defs.bzl and inspect the codex_rust_crate macro signature and its Args section, then compare them with the usages in codex-rs/bwrap/BUILD.bazel and the WebRTC-related BUILD files. Done means the docstring documents live parameters such as build_script_enabled and rustc_flags_extra, along with any other supported parameters omitted from the Args section.

Written by the indexing model from the issue text.

Description

documentation
What happened?

The codex_rust_crate macro signature in defs.bzl includes parameters that are not documented in the macro docstring's Args section.

Examples:

  • build_script_enabled
  • rustc_flags_extra

Both parameters are live: build_script_enabled is used to gate build script wiring, and rustc_flags_extra is passed into generated Bazel targets. BUILD files also use these parameters, for example codex-rs/bwrap/BUILD.bazel and several WebRTC-related crates.

Expected behavior

The codex_rust_crate docstring should describe all supported macro parameters, especially parameters already used by first-party BUILD files, so future Bazel changes have accurate local API documentation.

Additional context

I searched open issues and PRs for terms including codex_rust_crate, build_script_enabled, rustc_flags_extra, and docstring, and did not find an existing open item that appears to cover these missing Args entries.

Dominant language
Rust
Stars
125k
Forks
19.5k
Avg merge
1m
Merged PRs (30d)
1k

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openai/codex

All issues in openai/codex

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.