Skip to content

Conversation

@gastmaier
Copy link

@gastmaier gastmaier commented Mar 6, 2025

xml_gen will likely be renamed to iio-emu_gen_xml on the next release.

analogdevicesinc/iio-emu@cbc0c04

Summary by Sourcery

Documentation:

  • Update documentation to reflect the renaming of the xml_gen tool to iio-emu_gen_xml.

analogdevicesinc/iio-emu cbc0c0419767a30321b627581fbe6f62f1ce4e80

Signed-off-by: Jorge Marques <[email protected]>
@sourcery-ai
Copy link

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

The documentation has been updated to reflect the renaming of the xml_gen tool to iio-emu_gen_xml. This includes updating the command examples and descriptions in the emulation.md file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the documentation to reflect the renaming of xml_gen to iio-emu_gen_xml.
  • Replaced xml_gen with iio-emu_gen_xml in the command example.
  • Updated the description to use the new name.
docs/emulation.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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.

1 participant