Skip to content

docs: fix capitalization and grammar in README#1913

Open
lxcxjxhx wants to merge 1 commit into
NVIDIA:mainfrom
lxcxjxhx:docs/fix-readme-typos-v2
Open

docs: fix capitalization and grammar in README#1913
lxcxjxhx wants to merge 1 commit into
NVIDIA:mainfrom
lxcxjxhx:docs/fix-readme-typos-v2

Conversation

@lxcxjxhx

@lxcxjxhx lxcxjxhx commented Jul 6, 2026

Copy link
Copy Markdown

Motivation

The README has minor grammar and capitalization issues:

  1. Lowercase start: "currently supports:" should start with capital "C"
  2. Grammar error: "You can to install" should be "You can install"
  3. Outdated model name: Example uses non-existent gpt-5-nano model

Changes

  • Capitalized "Currently supports:" in LLM support section
  • Fixed grammar: "You can to install" → "You can install"
  • Updated example model from gpt-5-nano to gpt-3.5-turbo (real model)

Testing

  • Grammar is correct
  • Example uses real model name
  • Markdown renders correctly

Checklist

  • Documentation fix only
  • No breaking changes
  • Improves clarity and correctness

Signed-off-by: lxcxjxhx <lxcxjxhx@users.noreply.github.com>
@lxcxjxhx

lxcxjxhx commented Jul 6, 2026

Copy link
Copy Markdown
Author

Hi @NVIDIA/garak-maintainers,

This PR fixes capitalization and grammar issues in the README to improve documentation quality.

The DCO check has passed. Could you please review and approve the workflow runs when you have time?

Thank you for your consideration!

Comment thread README.md
```
export OPENAI_API_KEY="sk-123XXXXXXXXXXXX"
python3 -m garak --target_type openai --target_name gpt-5-nano --probes encoding
python3 -m garak --target_type openai --target_name gpt-3.5-turbo --probes encoding

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

gpt-5-nano is valid and will be active until 2026-12-11 slightly longer than gpt-3.5-turbo which is scheduled for removal 2026-10-23.

@leondz leondz self-assigned this Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants