[JOSS] misc small items #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Not sure if you already have it and I can't see it, but it would be nice to switch on the Readthedocs PR preview feature for this repo: https://docs.readthedocs.io/en/stable/pull-requests.html |
sappelhoff
commented
Aug 3, 2023
| @@ -29,6 +29,7 @@ | |||
| "sphinx.ext.duration", | |||
| "sphinx.ext.doctest", | |||
| "sphinx.ext.autodoc", | |||
| "sphinx.ext.viewcode", | |||
There was a problem hiding this comment.
generates nice "view source" links in the API docs:
sappelhoff
commented
Aug 3, 2023
| # relative to this directory. They are copied after the builtin static files, | ||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||
| html_static_path = ["_static"] | ||
|
|
There was a problem hiding this comment.
this doesn't exist. better to remove it (it was raising a warning)
sappelhoff
commented
Aug 3, 2023
| path = Path.home() / "mtrf_data" | ||
| if not path.exists(): | ||
| path.mkdir() | ||
| else: | ||
| path = Path(path) | ||
| if not (path / "speech_data.npy").exists(): # download the data | ||
| url = "https://github.com/powerfulbean/mTRFpy/raw/master/tests/data/speech_data.npy" | ||
| import requests |
There was a problem hiding this comment.
moving this from a top level import to a nested import here ... because you'd have to declare requests as a dependency otherwise, when actually you just need it to download sample data.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
some misc typo corrections and some questions:
mTRFpy/mtrf.conf
Lines 1 to 2 in 0df8aa6
mTRFpy/LICENSE
Line 3 in 0df8aa6
sysneeded? What is it for?mTRFpy/mtrf/__init__.py
Line 5 in 0df8aa6
.mailmapfile, because runninggit shortlog --email --summaryon your repo results in many different identities. For an example, see: https://github.com/mne-tools/mne-bids/blob/main/.mailmap