Skip to content

docs: fix Oscilloscope image source in documentation#3150

Merged
marcnause merged 2 commits into
fossasia:flutterfrom
Diksha-MukherjeeAgarwal:patch-1
Apr 12, 2026
Merged

docs: fix Oscilloscope image source in documentation#3150
marcnause merged 2 commits into
fossasia:flutterfrom
Diksha-MukherjeeAgarwal:patch-1

Conversation

@Diksha-MukherjeeAgarwal

@Diksha-MukherjeeAgarwal Diksha-MukherjeeAgarwal commented Mar 31, 2026

Copy link
Copy Markdown
Contributor

Change instrument_oscilloscope_channelparam to oscilloscope_channel_params.png to fix the broken image link.

Summary by Sourcery

Documentation:

  • Fix broken oscilloscope channel parameters image link in the documentation.

@sourcery-ai

sourcery-ai Bot commented Mar 31, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the oscilloscope documentation image reference to point to the correct, existing image file, fixing a broken image link in the docs.

File-Level Changes

Change Details Files
Corrected the oscilloscope channel parameter image filename in the documentation to match the actual asset and restore the image display.
  • Updated the image src attribute for the oscilloscope channel parameters screenshot to use the correct filename with _channel_params
  • Left the surrounding documentation structure and second image reference unchanged
docs/Oscilloscope.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!

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Diksha-MukherjeeAgarwal Diksha-MukherjeeAgarwal changed the title Fix Oscilloscope image source in documentation docs: fix Oscilloscope image source in documentation Mar 31, 2026

@rahul31124 rahul31124 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Fixes a broken image link in the oscilloscope documentation by updating the referenced filename to an existing asset under docs/images/.

Changes:

  • Update the oscilloscope “Channel Parameters” image source to oscilloscope_channel_params.png to resolve a broken link.

@marcnause marcnause enabled auto-merge (squash) April 7, 2026 09:52
@marcnause

Copy link
Copy Markdown
Contributor

Closing (and reopening a second later) this PR to force the CI to exit hung state and build the Android and IOS apps.

@marcnause marcnause closed this Apr 7, 2026
auto-merge was automatically disabled April 7, 2026 10:24

Pull request was closed

@marcnause marcnause reopened this Apr 7, 2026
@rahul31124

Copy link
Copy Markdown
Member

Hello @marcnause ,

I think reopening the PR might not work in this case because of this: #3126.
We may need to modify the CI files a little bit.

@marcnause

Copy link
Copy Markdown
Contributor

Good point @rahul31124! I think @CloudyPadmal and I came up with the idea together and both missed that this may also have negative effects. I created a new issue: #3168

@marcnause

Copy link
Copy Markdown
Contributor

Can't merge via command line since the flutter branch is protected. Will set this PR to "blocked".

@marcnause marcnause added Status: Blocked Cannot carry out further development Documentation Non-code related documentation tasks labels Apr 7, 2026
Change instrument_oscilloscope_channelparam to oscilloscope_channel_params.png to fix the broken image link.
@marcnause marcnause removed the Status: Blocked Cannot carry out further development label Apr 12, 2026
@marcnause marcnause merged commit 99fd6e2 into fossasia:flutter Apr 12, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Non-code related documentation tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants