[Docs] various docs fixes #834
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
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## dev #834 +/- ##
==========================================
- Coverage 53.83% 53.82% -0.01%
==========================================
Files 295 295
Lines 13800 13802 +2
==========================================
Hits 7429 7429
- Misses 6371 6373 +2
☔ View full report in Codecov by Sentry. |
Trying to address D:\a\NeuroKit\NeuroKit\neurokit2\complexity\optim_complexity_tolerance.py:docstring of neurokit2.complexity.optim_complexity_tolerance.complexity_tolerance:181: WARNING: Duplicate explicit target name: "study". https://github.com/neuropsychology/NeuroKit/actions/runs/5124886426/jobs/9217327755?pr=834
trying to address D:\a\NeuroKit\NeuroKit\neurokit2\complexity\complexity.py:docstring of neurokit2.complexity.complexity.complexity:129: WARNING: Duplicate explicit target name: "study". https://github.com/neuropsychology/NeuroKit/actions/runs/5124886426/jobs/9217327755?pr=834 in case the issue is that the word "study" is associated with 2 links?
Trying to address D:\a\NeuroKit\NeuroKit\neurokit2\complexity\fractal_tmf.py:112: FutureWarning: Calling float on a single element Series is deprecated and will raise a TypeError in the future. Use float(ser.iloc[0]) instead w[i] = fractal_dfa(surro, multifractal=True, show=False)[0]["Width"] https://github.com/neuropsychology/NeuroKit/actions/runs/5127313194/jobs/9222791783?pr=834
D:\a\NeuroKit\NeuroKit\neurokit2\signal\signal_plot.py:141: FutureWarning: RangeIndex.is_integer is deprecated. Use pandas.api.types.is_integer_dtype instead. if sampling_rate is None and signal.index.is_integer(): https://github.com/neuropsychology/NeuroKit/actions/runs/5127603215/jobs/9223420227?pr=834
aiming to address D:\a\NeuroKit\NeuroKit\neurokit2\eeg\mne_channel_extract.py:67: FutureWarning: The default for pick_channels will change from ordered=False to ordered=True in 1.5 and this will result in a change of behavior because the resulting channel order will not match. Either use a channel order that matches your instance or pass ordered=False.
see rsp_phase.py
danibene
changed the title
|
Amazing, thanks so much Dani! |
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.
Description
Seems I forgot to include all the outputs in the docstring for
intervals_process().Proposed Changes
I added interpolation_rate to the docstring of the
intervals_process()function so that it reflects what the function does.update: I also made some changes to address some of the warnings in the documentation check
Checklist
Here are some things to check before creating the PR. If you encounter any issues, do let us know :)