Skip to content

Updated API guidance to recommend official clients first:#820

Open
vishnandaman wants to merge 4 commits intoibutsu:mainfrom
vishnandaman:improved-docs
Open

Updated API guidance to recommend official clients first:#820
vishnandaman wants to merge 4 commits intoibutsu:mainfrom
vishnandaman:improved-docs

Conversation

@vishnandaman
Copy link
Copy Markdown
Contributor

@vishnandaman vishnandaman commented Mar 26, 2026

I have updated the code to recommend the api-client first before raw curl example
and removed the duplicated sentence in the JUnit UI subsection

Summary by Sourcery

Update API usage documentation to prioritize official client guidance and clean up related user guide content.

Documentation:

  • Adjust getting started and filter help docs to recommend the official API client before raw curl usage.
  • Remove a duplicated sentence in the JUnit UI subsection and add a dedicated widgets user guide page.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 26, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates documentation to prioritize recommending the official API client over raw curl examples, cleans up duplicated guidance in the JUnit UI subsection, and introduces/updates a widgets user-guide page.

File-Level Changes

Change Details Files
Reorder and update top-level API usage guidance to prefer official clients over raw curl examples.
  • Adjust introductory API guidance text to highlight official api-client libraries as the primary recommendation
  • Demote or rephrase raw curl example documentation to be secondary or alternative guidance
docs/source/index.rst
Align user guide API/filter examples with the new recommendation order.
  • Update filter-related help text where API usage is shown to reference the official client first
  • Ensure any curl-based examples are clearly positioned as lower-level or advanced usage
docs/source/user-guide/filter-help.rst
docs/source/user-guide/getting-started.rst
Clean up and extend user guide content for widgets, including JUnit UI, while removing duplicated sentences.
  • Create or substantially revise the widgets user-guide page to document widget-related functionality
  • Update the JUnit UI subsection text and remove the duplicated sentence to avoid redundancy
docs/source/user-guide/widgets.rst

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

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/source/user-guide/widgets.rst" line_range="23-24" />
<code_context>
+-------------------------------------
+
+#. With a project and dashboard selected, click **Add Widget**.
+#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
+   type (for example Jenkins job name, number of builds, or grouping field).
+#. Save. The widget appears on the grid; use the actions on the widget card to **edit** or
+   **delete** it later.
</code_context>
<issue_to_address>
**nitpick (typo):** Optional grammar tweak: add a comma after "for example" for smoother reading.

Specifically, in this sentence: "for example, Jenkins job name, number of builds, or grouping field." This is optional polish only.

```suggestion
#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
   type (for example, Jenkins job name, number of builds, or grouping field).
```
</issue_to_address>

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.

Comment on lines +23 to +24
#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
type (for example Jenkins job name, number of builds, or grouping field).
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.

nitpick (typo): Optional grammar tweak: add a comma after "for example" for smoother reading.

Specifically, in this sentence: "for example, Jenkins job name, number of builds, or grouping field." This is optional polish only.

Suggested change
#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
type (for example Jenkins job name, number of builds, or grouping field).
#. In the wizard, choose a **widget type**, set a **title**, and fill in the parameters for that
type (for example, Jenkins job name, number of builds, or grouping field).

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.40%. Comparing base (fa326b8) to head (a45de3b).

❌ Your project check has failed because the head coverage (73.40%) is below the target coverage (85.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #820   +/-   ##
=======================================
  Coverage   73.40%   73.40%           
=======================================
  Files         154      154           
  Lines        7557     7557           
  Branches      660      660           
=======================================
  Hits         5547     5547           
  Misses       1790     1790           
  Partials      220      220           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa326b8...a45de3b. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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