docs: Include output from first example in README

[jmgate]

Type: Documentation

Description

To better advertise what the package provides, without requiring the reader to jump to (or further into) the documentation, include the output from running the first example script with both stages defined in the README.md file, which will be displayed on GitHub and PyPI, and the index.rst file, which will be displayed on ReadTheDocs.

Note that this incurs a minimal maintenance burden, in that we'll need to keep this output up-to-date with any changes to the package that affect the output.

Related Issues/PRs

Closes #249.

Summary by Sourcery

Documentation:

• Add a rendered example of running the first staged script to the README to showcase typical output without leaving the page.

[sourcery-ai]

Reviewer's Guide

Adds the concrete console output of the first staged script example to the top-level README and Sphinx index to better showcase what running the example looks like.

File-Level Changes

Change	Details	Files
Document the actual console output of running the first staged script example to make the package behavior more tangible to readers.	Append a fenced code block in the README after the first usage example showing a full sample invocation of the staged script, including log lines, commands executed, timing table, and final success message. Mirror this example output in the Sphinx documentation index so ReadTheDocs displays the same concrete example result as the README.	README.md doc/source/index.rst

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#249	Add the output produced by running the existing example script to README.md so that readers can see the tool’s result, not just the example code.	✅

Possibly linked issues

• Add output from the example in the README.md #249: PR exactly implements the issue’s request by adding the example’s output to README and docs index.

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `doc/source/index.rst:105` </location>
<code_context>
     my_script.main(sys.argv[1:])
 ```

+Executing the script then yields
+```
+>>> my_staged_script.py --stage hello goodbye
</code_context>

<issue_to_address>
**nitpick (typo):** Consider adding a colon at the end of this sentence to clearly introduce the following output.

Since this line introduces the console output, consider phrasing it as `Executing the script then yields:` for smoother readability.

```suggestion
Executing the script then yields:
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (74a1d8b) to head (fd78f50).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #250   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          177       177           
  Branches        15        15           
=========================================
  Hits           177       177           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jmgate]

@william76, is this what you had in mind?

[william76]

@jmgate Yup, that looks great! I think you had something like that on the RTD pages. It's nice to have that on the readme here on github too since that'll be the first place many people look and will give them an idea of what the package does.

also... LGTM! 😉