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

Correct method default in docstring #3570

Merged

Conversation

chrishalcrow
Copy link
Collaborator

Fixes #3566

Correct the default method docstring in compute_unit_locations. Was center_of_mass but monopolar_triangulation is actually the default.

@chrishalcrow chrishalcrow added the documentation Improvements or additions to documentation label Dec 5, 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.

why or instead of |? We had decided on doing | in general, but have never enforced it. Do you want to make an argument for using or instead. The | in type hints is 3.10+, but in docstrings there are no rules.

@chrishalcrow
Copy link
Collaborator Author

why or instead of |? We had decided on doing | in general, but have never enforced it. Do you want to make an argument for using or instead. The | in type hints is 3.10+, but in docstrings there are no rules.

Oh, crud. Yes indeed, that's in our docstring conventions - my mistake!

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.

good by me.

@alejoe91 alejoe91 merged commit 4a9fc04 into SpikeInterface:main Dec 5, 2024
15 checks passed
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.

Default plot_unit_locations method is not what is documented
3 participants