juaml/junifer
Watch
3
0
Fork
You've already forked junifer
 0
Code Issues 14 Pull requests 2 Packages Activity Actions

[ENH]: Add flowchart for users and improve docs #210

Merged
fraimondo merged 14 commits from enh/docs_flowchart into main 2023-03-30 20:03:18 +00:00
Conversation 8 Commits 14 Files changed 12 +348 -3
fraimondo commented 2023-03-28 08:54:26 +00:00 (Migrated from github.com)
Copy link

Add a flowchart so users can be guided through the documentation.

Add a flowchart so users can be guided through the documentation.
codecov[bot] commented 2023-03-28 08:55:43 +00:00 (Migrated from github.com)
Copy link

Codecov Report

Merging #210 (3f5adb9) into main (04a8d26) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #210   +/-   ##
=======================================
  Coverage   93.33%   93.33%           
=======================================
  Files          80       80           
  Lines        3435     3435           
  Branches      644      644           
=======================================
  Hits         3206     3206           
  Misses        151      151           
  Partials       78       78
Flag Coverage Δ
docs 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
docs/conf.py 100.00% <ø> (ø)
## [Codecov](https://codecov.io/gh/juaml/junifer/pull/210?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#210](https://codecov.io/gh/juaml/junifer/pull/210?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (3f5adb9) into [main](https://codecov.io/gh/juaml/junifer/commit/04a8d260a27779a1a6cb1717217d67ac9bc73866?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (04a8d26) will **not change** coverage. > The diff coverage is `n/a`. [![Impacted file tree graph](https://codecov.io/gh/juaml/junifer/pull/210/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://codecov.io/gh/juaml/junifer/pull/210?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #210 +/- ## ======================================= Coverage 93.33% 93.33% ======================================= Files 80 80 Lines 3435 3435 Branches 644 644 ======================================= Hits 3206 3206 Misses 151 151 Partials 78 78 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/juaml/junifer/pull/210?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [docs/conf.py](https://codecov.io/gh/juaml/junifer/pull/210?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-ZG9jcy9jb25mLnB5) | `100.00% <ø> (ø)` | |
github-actions[bot] commented 2023-03-28 09:00:51 +00:00 (Migrated from github.com)
Copy link
PR Preview Action v1.3.0
Preview removed because the pull request was closed.
2023-03-30 20:09 UTC
[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.3.0 :---: Preview removed because the pull request was closed. 2023-03-30 20:09 UTC <!-- Sticky Pull Request Commentpr-preview -->
synchon (Migrated from github.com) requested changes 2023-03-30 14:27:16 +00:00
docs/help.rst
@ -0,0 +1,108 @@
.. include:: links.inc
synchon (Migrated from github.com) commented 2023-03-30 13:50:37 +00:00
Copy link

... lose ...

... lose ...
synchon (Migrated from github.com) commented 2023-03-30 14:06:21 +00:00
Copy link

I propose: "When we conceived Junifer, we thought of neuroimaging researchers' problems, and tried to come up with the best way to help them by building a tool that is easy to understand, learn and use. And of course, we are here to help you with your research."

I propose: "When we conceived Junifer, we thought of neuroimaging researchers' problems, and tried to come up with the best way to help them by building a tool that is easy to understand, learn and use. And of course, we are here to help you with your research."
synchon (Migrated from github.com) commented 2023-03-30 14:08:32 +00:00
Copy link

I propose: "If you have any questions, problems and / or suggestions, ..."

I propose: "If you have any questions, problems and / or suggestions, ..."
synchon (Migrated from github.com) commented 2023-03-30 14:09:08 +00:00
Copy link

"... help us help you"

"... **help us help you**"
synchon (Migrated from github.com) commented 2023-03-30 14:11:41 +00:00
Copy link

I would kind of put this in a slightly different way like so:
"Communication is the key for you to help us and in turn help you solve your problems. Hence, we have opened several communication channels for you to contact us in the way that is most convenient for you."

I would kind of put this in a slightly different way like so: "Communication is the key for you to help us and in turn help you solve your problems. Hence, we have opened several communication channels for you to contact us in the way that is most convenient for you."
synchon (Migrated from github.com) commented 2023-03-30 14:12:40 +00:00
Copy link

I propose: "Some people do ..."

I propose: "Some people do ..."
synchon (Migrated from github.com) commented 2023-03-30 14:15:22 +00:00
Copy link

I propose: "... prefer to communicate verbally ..."

I propose: "... **prefer to communicate verbally** ..."
synchon (Migrated from github.com) commented 2023-03-30 14:18:06 +00:00
Copy link

I propose: "Difficult to follow linearly."

I propose: "Difficult to follow linearly."
docs/help.rst
@ -0,0 +71,4 @@
In short, these are the 3 communication channels to get help:
#. Discussions on Github (`junifer Discussions`_):
synchon (Migrated from github.com) commented 2023-03-30 14:17:09 +00:00
Copy link

The + and - might be a bit confusing for users to understand and I would lean towards having "Pros" and "Cons" explicitly mentioned and divided for each point.

The + and - might be a bit confusing for users to understand and I would lean towards having "Pros" and "Cons" explicitly mentioned and divided for each point.
docs/starting.rst
@ -0,0 +1,158 @@
.. include:: links.inc
synchon (Migrated from github.com) commented 2023-03-30 14:24:03 +00:00
Copy link

read_adding_coordinates_start("Read Creating a Junifer extension")

read_adding_coordinates_start("Read Creating a Junifer extension")
synchon (Migrated from github.com) commented 2023-03-30 14:25:49 +00:00
Copy link

read_adding_coordinates_start("Read Creating a Junifer extension")

read_adding_coordinates_start("Read Creating a Junifer extension")
synchon (Migrated from github.com) commented 2023-03-30 14:26:07 +00:00
Copy link

solved => solve

solved => solve
fraimondo (Migrated from github.com) reviewed 2023-03-30 15:01:53 +00:00
docs/help.rst
@ -0,0 +1,108 @@
.. include:: links.inc
fraimondo (Migrated from github.com) commented 2023-03-30 15:01:51 +00:00
Copy link

I specifically don't want to mention neuroimaging here. Although it's only for neuroimaging, it's also very useful for other kind of data (e.g. electrophysiology.)

I specifically don't want to mention neuroimaging here. Although it's only for neuroimaging, it's also very useful for other kind of data (e.g. electrophysiology.)
fraimondo (Migrated from github.com) reviewed 2023-03-30 15:08:12 +00:00
docs/help.rst
@ -0,0 +1,108 @@
.. include:: links.inc
fraimondo (Migrated from github.com) commented 2023-03-30 15:08:11 +00:00
Copy link

why do you like fancy words? This is for people that are looking for help because things are too complicated.

but I do agree with you.

why do you like fancy words? This is for people that are looking for help because things are too complicated. but I do agree with you.
synchon (Migrated from github.com) reviewed 2023-03-30 15:35:57 +00:00
docs/help.rst
@ -0,0 +1,108 @@
.. include:: links.inc
synchon (Migrated from github.com) commented 2023-03-30 15:35:56 +00:00
Copy link

Fair enough, so my proposal still stands with the removal of "neuroimaging".

Fair enough, so my proposal still stands with the removal of "neuroimaging".
synchon (Migrated from github.com) requested changes 2023-03-30 15:39:56 +00:00
docs/help.rst
@ -0,0 +42,4 @@
We can continue with the song, but we think you get the point. The point is that we will need help, and we will need
to ask for it. We will need to ask for help from our colleagues, from our supervisors, from our friends.
synchon (Migrated from github.com) commented 2023-03-30 15:38:03 +00:00
Copy link

Has an indented new line here in the final render.

Has an indented new line here in the final render.
synchon (Migrated from github.com) commented 2023-03-30 15:39:01 +00:00
Copy link

I would not put the "mind readers" part specifically and words in and around it.

I would not put the "mind readers" part specifically and words in and around it.
synchon (Migrated from github.com) approved these changes 2023-03-30 19:56:37 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
synchon
Labels
Clear labels   
CRITICAL
High Priority Issue

  
Stale

   
WIP
Work in progress

  
bug
Something isn't working

  
concept
Design/Implementation concepts

  
coordinate
Issues or pull requests related to coordinates (ROIs)

  
dataset
Issues or pull requests related to datagrabbers or datasets

  
dependencies
Pull requests that update a dependency file

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
github_actions
Pull requests that update GitHub Actions code

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
maintenance
Issues or pull requests related to maintenance

  
maps
Issues or pull requests related to maps (probabilistic atlases)

  
marker
Issues or pull requests related to markers

  
mask
Issues or pull requests related to masks

  
on hold
Issue waiting on other issue(s)

  
parcellation
Issues or pull requests related to parcellations (deterministic atlases)

  
preprocess
Issues or pull requests related to preprocessors

  
question
Further information is requested

  
ready
Pull request is ready for review and merge

  
storage
Issues or pull requests related to marker storage or retrieval

  
template-space
Issues or pull requests related to template spaces

  
triage
New issues waiting to be reviewed

  
wontfix
This will not be worked on

No labels
CRITICAL
Stale
WIP
bug
concept
coordinate
dataset
dependencies
documentation
duplicate
enhancement
github_actions
good first issue
help wanted
invalid
maintenance
maps
marker
mask
on hold
parcellation
preprocess
question
ready
storage
template-space
triage
wontfix
Milestone
Clear milestone
No items
No milestone
0.0.2 (alpha 1)
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
juaml/junifer!210
No description provided.