Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Update shortcuts in README.md #391

Merged
merged 2 commits into from
Dec 16, 2024
Merged

[DOC] Update shortcuts in README.md #391

merged 2 commits into from
Dec 16, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Dec 16, 2024

Changes proposed in this pull request:

  • Removes unnecessary top-level Neurobagel API shortcut (was somehow added back in [ENH] Add consistent badges #387 👀)
  • Update the license heading level so it's not under the default query section

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass
  • If the PR changes the SPARQL query template, the default Neurobagel query file has also been regenerated

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Update the README.md by removing the redundant 'Neurobagel API' shortcut and adjusting the license heading to a top-level heading for better organization.

Documentation:

  • Remove the unnecessary top-level 'Neurobagel API' shortcut from the README.md file.
  • Update the license heading level in the README.md to be a top-level heading.

@alyssadai alyssadai added the pr-documentation Change that only affects user documentation label Dec 16, 2024
Copy link

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

The PR updates the README.md file by reorganizing the table of contents and adjusting heading levels. The changes are implemented through simple text modifications in the markdown file, removing a redundant top-level shortcut and promoting the License section to a top-level heading.

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

File-Level Changes

Change Details Files
Reorganize table of contents structure
  • Remove redundant 'Neurobagel API' top-level entry
  • Adjust indentation levels of remaining entries to maintain hierarchy
README.md
Update License section heading level
  • Change License heading from H3 (###) to H2 (##) to make it a top-level section
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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.09%. Comparing base (3fe810b) to head (4654fcb).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #391   +/-   ##
=======================================
  Coverage   97.09%   97.09%           
=======================================
  Files          24       24           
  Lines         861      861           
=======================================
  Hits          836      836           
  Misses         25       25           

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

@alyssadai alyssadai added the release Create a release when this PR is merged label Dec 16, 2024
@alyssadai alyssadai marked this pull request as ready for review December 16, 2024 22:45
@alyssadai alyssadai requested a review from surchs December 16, 2024 22:45
Copy link

@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 @alyssadai - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

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

🧑‍🍳

@alyssadai alyssadai merged commit 8e1c289 into main Dec 16, 2024
11 checks passed
@alyssadai alyssadai deleted the alyssadai-patch-1 branch December 16, 2024 22:51
@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Dec 16, 2024
@alyssadai alyssadai added skip-release PR doesn't appear in the changelog and preserves current version when merged and removed release Create a release when this PR is merged pr-documentation Change that only affects user documentation released This issue/pull request has been released. labels Dec 17, 2024
@neurobagel neurobagel deleted a comment from neurobagel-bot bot Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-release PR doesn't appear in the changelog and preserves current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants