Skip to content

Update documentation to include GE file functionality#443

Merged
smoia merged 5 commits intophysiopy:masterfrom
nw-duncan:master
Apr 13, 2023
Merged

Update documentation to include GE file functionality#443
smoia merged 5 commits intophysiopy:masterfrom
nw-duncan:master

Conversation

@nw-duncan
Copy link
Copy Markdown
Contributor

@nw-duncan nw-duncan commented Mar 18, 2023

Minor changes to the documentation were made to introduce the additional GE scanner physiological file functionality.

Proposed Changes

That GE file functionality now exists is stated and some specific instructions were added to the "how to".

The API section was also updated to include the load_gep function that loads in GE files.

Change Type

  • bugfix (+0.0.1)
  • minor (+0.1.0)
  • major (+1.0.0)
  • refactoring (no version update)
  • test (no version update)
  • infrastructure (no version update)
  • documentation (no version update)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 18, 2023 •
edited
Loading

Codecov Report

Merging #443 (d3a7443) into master (d5d8f9c) will not change coverage.
The diff coverage is n/a.

❗ Current head d3a7443 differs from pull request most recent head d222a4c. Consider uploading reports for the commit d222a4c to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #443   +/-   ##
=======================================
  Coverage   94.25%   94.25%           
=======================================
  Files           8        8           
  Lines         974      974           
=======================================
  Hits          918      918           
  Misses         56       56
Impacted Files Coverage Δ
phys2bids/io.py 96.63% <ø> (ø)

@nw-duncan
Copy link
Copy Markdown
Contributor Author

nw-duncan commented Apr 6, 2023

It looks like this same error is occurring for other pull requests too:

image

A file missing somewhere, apparently, but I can't find out much more than that to try and solve it.

smoia
smoia reviewed Apr 13, 2023
View reviewed changes
smoia
smoia reviewed Apr 13, 2023
View reviewed changes
smoia
smoia approved these changes Apr 13, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@smoia smoia left a comment

Choose a reason for hiding this comment

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

LGTM!

@smoia
Copy link
Copy Markdown
Member

smoia commented Apr 13, 2023

Don't worry about the pre-commit "error", it is indeed due to a configuration file not being there. The reason is that we need to push in quite a lot of refactoring before we do add it.
Equally, don't worry about the failing on test 310. It's not relevant to your PR, and I'll fix it straight after this PR gets merged.

@smoia smoia added the Documentation This issue or PR is about the documentation label Apr 13, 2023
@smoia smoia merged commit e1910ce into physiopy:master Apr 13, 2023
@smoia
Copy link
Copy Markdown
Member

smoia commented Apr 26, 2023

🚀 PR was released in 2.8.4 🚀

@smoia smoia added the released This issue/pull request has been released. label Apr 26, 2023
@nw-duncan
Copy link
Copy Markdown
Contributor Author

nw-duncan commented Apr 27, 2023 via email

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

Reviewers

@smoia smoia smoia approved these changes

Assignees

No one assigned

Labels

Documentation This issue or PR is about the documentation released This issue/pull request has been released.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nw-duncan @smoia