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.

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

[REF, DOC] Make non-user-facing utility functions semi-private and improve docs #604

Merged
merged 9 commits into from
Nov 10, 2021

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Nov 8, 2021

Closes None.

Changes proposed in this pull request:

  • In order to simplify the API, I've made a number of internal functions private(ish).
  • Remove the roadmap file in the documentation and move the relevant contents to the about file.
  • Remove most of the information about the NeuroStore ecosystem from the about file.
  • Reorganize examples to be a bit clearer.

@tsalo tsalo added documentation Improving documentation for the project refactoring Requesting changes to the code which do not impact behavior labels Nov 8, 2021
@codecov
Copy link

codecov bot commented Nov 8, 2021

Codecov Report

Merging #604 (681f49e) into main (803b5c8) will not change coverage.
The diff coverage is 91.13%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #604   +/-   ##
=======================================
  Coverage   85.76%   85.76%           
=======================================
  Files          40       40           
  Lines        4390     4390           
=======================================
  Hits         3765     3765           
  Misses        625      625           
Impacted Files Coverage Δ
nimare/annotate/lda.py 23.75% <33.33%> (ø)
nimare/extract/utils.py 38.58% <50.00%> (ø)
nimare/meta/kernel.py 96.49% <50.00%> (ø)
nimare/decode/continuous.py 95.00% <66.66%> (ø)
nimare/utils.py 94.29% <92.30%> (ø)
nimare/annotate/cogat.py 91.35% <100.00%> (ø)
nimare/dataset.py 89.12% <100.00%> (ø)
nimare/decode/discrete.py 96.72% <100.00%> (ø)
nimare/meta/cbma/base.py 93.67% <100.00%> (ø)
nimare/meta/ibma.py 100.00% <100.00%> (ø)
... and 3 more

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 803b5c8...681f49e. Read the comment docs.

@tsalo tsalo merged commit 2f93987 into neurostuff:main Nov 10, 2021
@tsalo tsalo deleted the more-docs branch November 10, 2021 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improving documentation for the project refactoring Requesting changes to the code which do not impact behavior
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant