Skip to content

docs: fix typos in docs and README - #2024

Open
toyeshhm wants to merge 2 commits into
dottxt-ai:mainfrom
toyeshhm:docs/fix-doc-typos
Open

toyeshhm wants to merge 2 commits into
dottxt-ai:mainfrom
toyeshhm:docs/fix-doc-typos

Conversation

@toyeshhm

@toyeshhm toyeshhm commented Aug 25, 2026 •

Copy link
Copy Markdown

Twenty-six corrections across the documentation and README.

Two are more than cosmetic:

  • docs/features/advanced/backends.md uses outlines.Generaor(model, output_type) in a code sample, so the snippet raises AttributeError as written.
  • The same file lists the steerable model as LlmaCpp. The exported class is LlamaCpp — matching SteerableModel = Union[LlamaCpp, MLXLM, Transformers] in src/outlines/models/__init__.py, and the spelling used in the other 14 places the docs mention it.

The rest are prose and code-comment typos. The largest group is messsage, which appears in the chat-inputs paragraph of all nine model pages (anthropic, gemini, mistral, ollama, openai, sglang, transformers, vllm, vllm_offline) — it looks like one paragraph was copy-pasted across them.

The second commit fixes two repeated words: "Large CFG strings should be be wrapped" and "using a a function instead of a template".

Every edit is a single word; no wording or content changes beyond the corrections.

Fixes 24 spelling errors across the documentation. Two of these are more
than cosmetic:

- `docs/features/advanced/backends.md` had `outlines.Generaor(...)` in a
  code sample, so the snippet as written raises AttributeError.
- The same file referred to the steerable model `LlmaCpp`; the exported
  class is `LlamaCpp` (spelled correctly in the other 14 places the docs
  mention it).

The rest are prose and code-comment typos, including `messsage` which had
been copy-pasted into the chat-inputs section of all nine model pages.
Copilot AI lite review requested due to automatic review settings August 25, 2026 19:11

Copilot AI 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.

Copilot wasn't able to review any files in this pull request.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

"Large CFG strings should be be wrapped" and "using a a function
instead of a template".

This branch has not been deployed

No deployments
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.

2 participants