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

[ENH] making dataset hyperlinks more recognizable #457

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

Tusharjamdade
Copy link
Contributor

@Tusharjamdade Tusharjamdade commented Jan 27, 2025

Changes proposed in this pull request:

  • Enhance dataset link visibility with underline and icon

NOTE: If this pull request is to be released, the release label must be applied once the review process is done to avoid the local and remote from going out of sync as a consequence of the bump version workflow run

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 participant-level and/or the dataset-level result file, the query-tool-results files in the neurobagel_examples repo have 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

Enhancements:

  • Make dataset links more visually distinct with underlines and icons.

Copy link

sourcery-ai bot commented Jan 27, 2025

Reviewer's Guide by Sourcery

This pull request enhances the visibility of dataset links by adding an underline and an icon to the link.

Class diagram for ResultCard component changes

classDiagram
  class ResultCard {
    +datasetName: string
    +datasetPortalURI: string
    +render()
  }
  note for ResultCard "Modified styling:
  - Added underline to dataset name
  - Added OpenInNewIcon
  - Updated link container styles"
Loading

File-Level Changes

Change Details Files
Added an underline and an icon to dataset links to improve their visibility.
  • Added OpenInNewIcon import from '@mui/icons-material/OpenInNew'.
  • Modified the dataset link style to include 'display: flex', 'alignItems: center', and 'gap: 0.25rem'.
  • Added 'textDecoration: underline' to the Typography component within the link.
  • Added an OpenInNewIcon component after the dataset name Typography component.
src/components/ResultCard.tsx

Assessment against linked issues

Issue Objective Addressed Explanation
#451 Make hyperlinks for matching datasets more visually obvious to users
#451 Improve link recognition without requiring users to hover

Possibly linked issues


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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@github-actions github-actions bot added the _community [BOT ONLY] PR label for community contributions. Used for tracking label Jan 27, 2025
Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for neurobagel-query ready!

Name Link
🔨 Latest commit 6059d14
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-query/deploys/6797f3ca4283cd0008f2a0ca
😎 Deploy Preview https://deploy-preview-457--neurobagel-query.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rmanaem rmanaem added the pr-patch Incremental feature improvement, will increment patch version when merged (0.0.+1) label Jan 27, 2025
@rmanaem rmanaem self-requested a review January 28, 2025 17:51
Copy link
Contributor

@rmanaem rmanaem left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @Tusharjamdade! This is good to go 🧑‍🍳

@rmanaem rmanaem merged commit 7b4a04b into neurobagel:main Jan 28, 2025
13 of 14 checks passed
Copy link
Contributor

🚀 PR was released in v0.9.0 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
_community [BOT ONLY] PR label for community contributions. Used for tracking pr-patch Incremental feature improvement, will increment patch version when merged (0.0.+1) released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make hyperlink on matching dataset card more obvious
2 participants