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

Clarify installation instructions and tutorial #382

Merged
merged 2 commits into from
Apr 11, 2021
Merged

Clarify installation instructions and tutorial #382

merged 2 commits into from
Apr 11, 2021

Conversation

drombas
Copy link
Contributor

@drombas drombas commented Jan 28, 2021

Closes #210

Small clarification of the documentation.

Proposed Changes

installation.rst

  • Clarify the difference between installation with and without pip
  • Clarify the installation steps
  • Correct setup.py installation command

howto.rst

  • Add phys2bids -h description as well as a link to the command line usage page.

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!

@drombas
Clarify the installation process
286ba44 
Changes:
- Explain the difference between pip and manual installation
- Clarify the installation steps 
- Correct the command for manual installation
@drombas
Add phys2bids -h description to howto.rst
d300712
@codecov
Copy link

codecov bot commented Jan 28, 2021 •
edited
Loading

Codecov Report

Merging #382 (d300712) into master (7915476) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #382   +/-   ##
=======================================
  Coverage   94.63%   94.63%           
=======================================
  Files           8        8           
  Lines         839      839           
=======================================
  Hits          794      794           
  Misses         45       45

smoia
smoia reviewed Feb 4, 2021
View reviewed changes
Copy link
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.

Hello @drombas!

Thank you for the PR! This LGTM!

@RayStick or others, do you want to have a look at it?

vinferrer
vinferrer approved these changes Feb 8, 2021
View reviewed changes
Copy link
Collaborator

@vinferrer vinferrer left a comment

Choose a reason for hiding this comment

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

LGTM too

@vinferrer
Copy link
Collaborator

Thought we should wait for others to merge this PR

@smoia smoia self-assigned this Apr 11, 2021
@smoia smoia added the Documentation This issue or PR is about the documentation label Apr 11, 2021
@smoia smoia merged commit 350933b into physiopy:master Apr 11, 2021
@smoia
Copy link
Member

smoia commented Apr 11, 2021

🚀 PR was released in 2.4.1 🚀

@smoia smoia added the released This issue/pull request has been released. label Apr 11, 2021
@drombas drombas deleted the clarify-documentation branch April 15, 2021 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smoia smoia smoia left review comments

@vinferrer vinferrer vinferrer approved these changes

Assignees

@smoia smoia

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.

Suggestion for installation instructions and phys2bids tutorial
3 participants
@drombas @vinferrer @smoia