Skip to content

Conversation

@normandy7
Copy link
Contributor

@normandy7 normandy7 commented Sep 25, 2025

Add docs link and remove "run or other object" phrasing.

Description

Include a summary of the changes and the related issue.

Related to: <ClickUp/JIRA task name>

Any expected test failures?


Add a [X] to relevant checklist items

❔ This change

  • adds a new feature
  • fixes breaking code
  • is cosmetic (refactoring/reformatting)

✔️ Pre-merge checklist

  • Refactored code (sourcery)
  • Tested code locally
  • Precommit installed and run before pushing changes
  • Added code to GitHub tests (notebooks, scripts)
  • Updated GitHub README
  • Updated the projects overview page on Notion

🧪 Test Configuration

  • OS:
  • Python version:
  • Neptune version:
  • Affected libraries with version:

Summary by Sourcery

Refine the repository README by updating table entry phrasing and adding a missing documentation link.

Documentation:

  • Simplify the ‘Resume run or other object’ heading to ‘Resume a run’ in the examples table
  • Add a documentation link for the PyTorch model internals example in the README

Add docs link and remove "run or other object" phrasing

Signed-off-by: Sabine Ståhlberg <[email protected]>
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 25, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR makes cosmetic updates to the main README by refining a table entry’s wording, adding a missing documentation link for the PyTorch model internals example, and introducing the corresponding docs anchor.

File-Level Changes

Change Details Files
Refine table entry phrasing
  • Update 'Resume run or other object' to 'Resume a run' in the examples table
README.md
Add documentation link for PyTorch model internals
  • Include a [docs-icon] link in the PyTorch model internals row
  • Ensure the table shows both Docs and Neptune icons for that entry
README.md
Introduce docs anchor for PyTorch model internals
  • Add a new [pytorch-model-internals] link definition pointing to the docs URL
README.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

Copy link
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 there - 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.

@SiddhantSadangi SiddhantSadangi merged commit b98cc59 into main Sep 25, 2025
9 checks passed
@SiddhantSadangi SiddhantSadangi deleted the sabine/readme-patch branch September 25, 2025 11:06
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.

3 participants