Skip to content

docs: fix multiple typos and broken code examples (#725)#802

Open
quietdom wants to merge 1 commit into
apache:mainfrom
quietdom:fix-doc-typos
Open

docs: fix multiple typos and broken code examples (#725)#802
quietdom wants to merge 1 commit into
apache:mainfrom
quietdom:fix-doc-typos

Conversation

@quietdom

@quietdom quietdom commented Jun 9, 2026

Copy link
Copy Markdown

What this PR does / why we need it

This PR fixes several documentation issues identified in #725:

  • Multiple typos in README.md and RST files
  • Fixed broken code example in README.md (response=content to response=response)
  • Fixed garbled command name in simple-example.rst
  • Fixed markdown link syntax to RST in install.rst
  • Fixed missing colon in function signature in actions.rst
  • Fixed missing closing quote in state-persistence.rst

Special notes for your reviewers

Closes #725

- Fix typo: 'too' → 'to' in README.md
- Fix code bug: response=content → response=response in README.md
- Fix grammar: 'use view' → 'use to view' in README.md
- Fix typo: 'asynchonous' → 'asynchronous' in actions.rst
- Fix missing colon on function signature in actions.rst
- Fix missing closing quote in state-persistence.rst
- Fix markdown link syntax to RST in install.rst
- Fix garbled command name in simple-example.rst
- Fix typo: 'lifeycyle' → 'lifecycle' in up-next.rst

Closes apache#725
@github-actions github-actions Bot added the area/website burr.apache.org website label Jun 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation typos, broken code examples, and remove decorative emoji

1 participant