Skip to content

docs: updated manual run with broker examples - #2402

Merged
Lancetnik merged 2 commits into
ag2ai:mainfrom
ArtyomVysotskiy:main
Aug 1, 2025
Merged

Lancetnik merged 2 commits into
ag2ai:mainfrom
ArtyomVysotskiy:main

Conversation

@ArtyomVysotskiy

Copy link
Copy Markdown
Contributor

Description

Fixes #2248 by correcting the "Manual run" example in documentation. The previous example showed incomplete code (app = FastStream(...)) which could confuse users. The new version provides complete examples while maintaining broker neutrality.

Type of change

  • Replaced the placeholder code with a complete working examples

Please delete options that are not relevant.

  • Documentation (typos, code examples, or any documentation updates)

Checklist

  • My code adheres to the style guidelines of this project (scripts/lint.sh shows no errors)
  • I have conducted a self-review of my own code
  • I have made the necessary changes to the documentation
  • My changes do not generate any new warnings
  • I have added tests to validate the effectiveness of my fix or the functionality of my new feature
  • Both new and existing unit tests pass successfully on my local environment by running scripts/test-cov.sh
  • I have ensured that static analysis tests are passing by running scripts/static-analysis.sh
  • I have included code examples to illustrate the modifications

@CLAassistant

CLAassistant commented Aug 1, 2025 •

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ ArtyomVysotskiy
❌ faststream-actions[bot]


faststream-actions[bot] seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 1, 2025
@Lancetnik
Lancetnik enabled auto-merge August 1, 2025 14:54
@Lancetnik
Lancetnik added this pull request to the merge queue Aug 1, 2025
Merged via the queue into ag2ai:main with commit 47f6845 Aug 1, 2025
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.

docs: "Manual run" example contains incorrect code

3 participants