Fix typos and buggy code in modules docs #4105
Open
+271
−215
Conversation
This file contains hidden or 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
chrishalcrow
added
documentation
zm711
reviewed
Aug 16, 2025
Co-authored-by: Zach McKenzie <[email protected]>
Co-authored-by: Zach McKenzie <[email protected]>
zm711
reviewed
Aug 18, 2025
zm711
reviewed
Aug 18, 2025
doc/modules/curation.rst
Outdated
| @@ -34,7 +34,7 @@ a subset of units from a spike sorting output and to perform some merges: | |||
| remove_unit_ids = [1, 2] | |||
| sorting_analyzer2 = sorting_analyzer.remove_units(remove_unit_ids=remove_unit_ids) | |||
|
|
|||
| # merge some units | |||
| # merge units 4 and 5, and units 7, 8 and 12 | |||
There was a problem hiding this comment.
should we say merge units 4 and 5 and separately units 7, 8 and 12 to emphasize the concept of merge groups more or do you think adding in the numbers is enough?
zm711
reviewed
Aug 18, 2025
zm711
reviewed
Aug 18, 2025
doc/modules/motion_correction.rst
Outdated
| ) | ||
| ) | ||
|
|
||
| Importantly, all the result and intermediate computations can returned to a motion object, for further loading, |
There was a problem hiding this comment.
Suggested change
| Importantly, all the result and intermediate computations can returned to a motion object, for further loading, | |
| Importantly, all the results and intermediate computations can returned to a motion object, for further loading, |
zm711
reviewed
Aug 18, 2025
zm711
reviewed
Aug 18, 2025
|
Genial. |
zm711
reviewed
Aug 21, 2025
Co-authored-by: Zach McKenzie <[email protected]>
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.
I went through all the modules docs, and tried to run all code in them (fun!!). This PR fixes anything obviously wrong that I found, mostly due to typos or deprecations that we never implemented in the docs. And fixed and text typos I found.
Aim was to fix code/typos and add some links, rather than dramatically improve/adjust docs.
When I felt the user might actually run the whole code-block, I added the necessary imports to make this smoother. Felt they weren't always needed.
Final PR from the Harvard docathon!!