Skip to content

fix(docs): fix typo in sandbox guide#3628

Merged
seratch merged 3 commits into
openai:mainfrom
mshsheikh:patch-63
Jun 12, 2026
Merged

fix(docs): fix typo in sandbox guide#3628
seratch merged 3 commits into
openai:mainfrom
mshsheikh:patch-63

Conversation

@mshsheikh

@mshsheikh mshsheikh commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Change "folder" to "folders" in the Manifest description table for grammatical correctness.

**Update the sandbox guide to use the documented File content parameter and fix a minor wording issue in the Manifest table.**

### Changes:
- Replace `File(text="internal notes")` with `File(content=b"internal notes")` in the Permissions example.
- Change "What files and folder should be present..."
  to "What files and folders should be present..."

## Rationale:
The sandbox guide currently uses the `text` parameter in the
Permissions example, while sandbox examples throughout the
repository consistently construct File entries using the
`content` field with byte literals (e.g. `content=b"..."`).

Aligning the guide with existing examples makes the
documentation consistent with established sandbox manifest
usage patterns and reduces confusion when following examples
across the documentation and example code.

This change is documentation-only and does not affect runtime
behavior.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 15134fcfcf

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/sandbox/guide.md Outdated
@seratch seratch added the documentation Improvements or additions to documentation label Jun 12, 2026
Update the Manifest row in the sandbox guide to use the correct plural form:

- Change "What files and folder should be present..." to "What files and folders should be present..."

This is a documentation-only change that improves grammar and clarity without affecting functionality.
@mshsheikh mshsheikh changed the title fix(docs): align sandbox guide examples with File API usage fix(docs): fix typo in sandbox guide Jun 12, 2026
@seratch seratch merged commit 1b0076d into openai:main Jun 12, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants