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.

Sign up for GitHub

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

Jump to bottom

[REF] Update SessionPath -> SessionFilePath #242

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[REF] Update SessionPath -> SessionFilePath #242

wants to merge 1 commit into from

Conversation

surchs
Copy link

@surchs surchs commented Nov 11, 2024 •
edited by sourcery-ai bot
Loading

Note: I could not get the test suite to run locally, this seems related / identical to e.g.: https://github.com/neurodatascience/cohort_creator/actions/runs/11661670644/job/32466434137#step:8:29

Summary by Sourcery

Rename 'SessionPath' to 'SessionFilePath' throughout the codebase to improve clarity and consistency, and update related test cases accordingly.

Enhancements:

  • Rename 'SessionPath' to 'SessionFilePath' across the codebase for clarity and consistency.

Tests:

  • Update test assertions to reflect the renaming of 'SessionPath' to 'SessionFilePath'.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Nov 11, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This PR implements a column name change from 'SessionPath' to 'SessionFilePath' across the codebase. The change is straightforward, involving updates to column names in DataFrame operations, test assertions, and file path handling functions.

Class diagram for DataFrame column update

classDiagram
    class DataFrame {
        +DatasetID
        +SubjectID
        +SessionID
        +SessionFilePath
    }
    note for DataFrame "Updated column name from 'SessionPath' to 'SessionFilePath'"
Loading

File-Level Changes

Change Details Files
Renamed 'SessionPath' column to 'SessionFilePath' in DataFrame operations
  • Updated column name in DataFrame initialization
  • Modified column name in path construction and assignment
  • Updated column name check in participant listing validation
  • Changed column reference in dataset name extraction logic
 cohort_creator/_utils.py
docs/visualize_neurobagel.py
Updated test assertions to reflect the new column name
  • Modified column name assertion in DataFrame structure test
 tests/test_utils.py

Assessment against linked issues

Issue Objective Addressed Explanation
#240 Update column name from 'SessionPath' to 'SessionFilePath' to match the new schema ✅

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.
  • 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

sourcery-ai[bot]
sourcery-ai bot reviewed Nov 11, 2024
View reviewed changes
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 @surchs - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please investigate why you cannot run the test suite locally and fix that issue. Being able to run and verify tests locally is important for maintaining code quality, even for straightforward changes like this one.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update to new schema for neurobagel query results
1 participant
@surchs