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

Improve save_to_folder docstring #2873

Merged
merged 7 commits into from
May 24, 2024

Conversation

h-mayorquin
Copy link
Collaborator

The old one is confusing and has references to extractor_name which can be confusing as some classess do have that attribute (at least for now).

@h-mayorquin h-mayorquin added the documentation Improvements or additions to documentation label May 17, 2024
@h-mayorquin h-mayorquin requested a review from zm711 May 17, 2024 15:40
@h-mayorquin h-mayorquin self-assigned this May 17, 2024
Copy link
Collaborator

@zm711 zm711 left a comment

Choose a reason for hiding this comment

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

A few comments + typo fixes :)

src/spikeinterface/core/base.py Outdated Show resolved Hide resolved
src/spikeinterface/core/base.py Outdated Show resolved Hide resolved
src/spikeinterface/core/base.py Outdated Show resolved Hide resolved
src/spikeinterface/core/base.py Outdated Show resolved Hide resolved
@zm711
Copy link
Collaborator

zm711 commented May 17, 2024

Maybe based on this discussion it would be good to really try to see what the community would get the most benefit from in our docstrings. hackathon topic

@h-mayorquin
Copy link
Collaborator Author

This is ready.

@h-mayorquin h-mayorquin merged commit f9e714f into SpikeInterface:main May 24, 2024
9 of 11 checks passed
@h-mayorquin h-mayorquin deleted the minor_doc_fixes branch May 24, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants