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

[DOC] Reorganize documentation #740

Merged
merged 11 commits into from
Jul 15, 2021
Merged

[DOC] Reorganize documentation #740

merged 11 commits into from
Jul 15, 2021

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jun 22, 2021 •
edited
Loading

Closes #677.

Changes proposed in this pull request:

  • Reorganize the documentation tree.
  • Fix the module role in the tedpca docstring.

@codecov
Copy link

codecov bot commented Jun 22, 2021 •
edited
Loading

Codecov Report

Merging #740 (16e5333) into main (cc78fcc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #740   +/-   ##
=======================================
  Coverage   92.66%   92.66%           
=======================================
  Files          27       27           
  Lines        2139     2139           
=======================================
  Hits         1982     1982           
  Misses        157      157
Impacted Files Coverage Δ
tedana/decomposition/pca.py 86.66% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cc78fcc...16e5333. Read the comment docs.

tsalo added 2 commits June 22, 2021 09:56
@tsalo
Fix docstring.
e15bdcd
@tsalo
Finish reorganization and heading standardization.
8e62b49 
Also add note about heading level formatting to CONTRIBUTING.md.
tsalo added a commit to tsalo/tedana that referenced this pull request Jul 7, 2021
@tsalo
Adopt heading convention from ME-ICA#740.
fc2d089
@tsalo tsalo marked this pull request as ready for review July 7, 2021 16:46
@tsalo
Copy link
Member Author

tsalo commented Jul 7, 2021

Cancelling the integration tests because this only impacts the documentation. I'll use my admin privileges to merge once I have the necessary reviews.

@tsalo tsalo requested review from emdupre and handwerkerd July 7, 2021 18:02
tsalo added a commit that referenced this pull request Jul 7, 2021
@tsalo @eurunuela
[DOC] Clarify communication pathways (#742)
4f4e5dc 
* Clarify communication pathways.

* Add note about mattermost.

* Apply suggestions from code review

Co-authored-by: Eneko Uruñuela <[email protected]>

* Adopt heading convention from #740.

Co-authored-by: Eneko Uruñuela <[email protected]>
jbteves
jbteves approved these changes Jul 12, 2021
View reviewed changes
Copy link
Collaborator

@jbteves jbteves left a comment

Choose a reason for hiding this comment

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

LGTM, this is awesome, thanks @tsalo !

@tsalo tsalo mentioned this pull request Jul 15, 2021
Merged
2 tasks
emdupre
emdupre approved these changes Jul 15, 2021
View reviewed changes
Copy link
Member

@emdupre emdupre left a comment

Choose a reason for hiding this comment

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

This looks great, thank you @tsalo !

My only real feedback is that it looks like "Processing multi-echo fMRI" was moved to "About ME-fMRI" from its previous grouping under "Using tedana." At least with the current wording, I feel like the connection to the surrounding content is a bit more tenuous now than it was previously.

I don't think that should hold up this PR (!), but maybe we can open an issue about updating the wording in "Processing multi-echo fMRI" to harmonize and highlight a more general, non-tedana framing.

@tsalo tsalo mentioned this pull request Jul 15, 2021
Closed
@tsalo
Copy link
Member Author

tsalo commented Jul 15, 2021

Thanks @emdupre! I've opened #755 for that and I'll merge this PR now.

@tsalo tsalo merged commit 2d6d91a into ME-ICA:main Jul 15, 2021
@tsalo tsalo deleted the rtd-reorg branch July 15, 2021 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emdupre emdupre emdupre approved these changes

@jbteves jbteves jbteves approved these changes

@handwerkerd handwerkerd Awaiting requested review from handwerkerd

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

Successfully merging this pull request may close these issues.

Reorganize RTD tree
3 participants
@tsalo @emdupre @jbteves