Skip to content

Add references to documentation page#2938

Merged
alejoe91 merged 11 commits intoSpikeInterface:mainfrom
Ashkees:ref_links
Jun 3, 2024
Merged

Add references to documentation page#2938
alejoe91 merged 11 commits intoSpikeInterface:mainfrom
Ashkees:ref_links

Conversation

@Ashkees
Copy link
Copy Markdown
Contributor

@Ashkees Ashkees commented May 30, 2024

No description provided.

@zm711 zm711 changed the title Stylistic changes from Zach Add references to documentation page May 30, 2024
@zm711 zm711 added the documentation Improvements or additions to documentation label May 30, 2024
Comment thread doc/references.rst

.. [Pouzat] `Using noise signature to optimize spike-sorting and to assess neuronal classification quality. 2002. <https://pubmed.ncbi.nlm.nih.gov/12535763/>`_

.. [Rolston] `Common median referencing for improved action potential detection with multielectrode arrays. 2009. <https://pubmed.ncbi.nlm.nih.gov/19964004/>`_
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note to ourselves: find more general reference for common referencing.

@h-mayorquin
Copy link
Copy Markdown
Collaborator

This looks great:
image

Thanks for your contribution @Ashkees

Copy link
Copy Markdown
Collaborator

@h-mayorquin h-mayorquin left a comment

Choose a reason for hiding this comment

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

I think this is a great addition. Why do some of the references apeared on gray>

Comment thread doc/references.rst Outdated
SpikeInterface stands on the shoulders of giants!
Each method in SpikeInterface draws on (or directly runs) independently-created methods.
Please try to reference the individual works that are important for your analysis pipeline.
If you notice a missing reference, please let us know by submitting an issue on Github.
Copy link
Copy Markdown
Collaborator

@h-mayorquin h-mayorquin Jun 1, 2024

Choose a reason for hiding this comment

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

Suggested change
If you notice a missing reference, please let us know by submitting an issue on Github.
If you notice a missing reference, please let us know by `submitting an issue <https://github.com/SpikeInterface/spikeinterface/issues/new>`_ on Github.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@h-mayorquin missing a space between the before the _ right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

should be good now!

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is still not displayed in the latest version : /

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It is on my side! Weird!

@alejoe91 alejoe91 added the hackathon-24 Contributions during the SpikeInterface Hackathon May 24 label Jun 1, 2024
Co-authored-by: Heberto Mayorquin <h.mayorquin@gmail.com>
@alejoe91
Copy link
Copy Markdown
Member

alejoe91 commented Jun 1, 2024

Thank you @Ashkees

This is an amazing contribution!!!

@zm711
Copy link
Copy Markdown
Member

zm711 commented Jun 3, 2024

Why do some of the references apeared on gray>

They appear gray when there are multiple. I think this is either a sphinx or rtd issue. The "blue" portion are the numbers after which are the actual links to the different spots. It's annoying, but I think it is the limitation now if we site the same paper in multiple places.

@alejoe91 @h-mayorquin
I think this is ready to merge with one caveat. The current reference for referencing only talks about median referencing. If you don't care about being general we can just merge now. If you want a more general ref about referencing then we can wait for that tiny patch.

But I agree @Ashkees, this is a wonderful contribution!

@h-mayorquin
Copy link
Copy Markdown
Collaborator

Fine for me to merge. I think @alejoe91 has a better grasp of what are good citation policies on the field and whether that citation makes sense.

@alejoe91
Copy link
Copy Markdown
Member

alejoe91 commented Jun 3, 2024

Let's merge :)

@alejoe91 alejoe91 merged commit cac7402 into SpikeInterface:main Jun 3, 2024
@samuelgarcia
Copy link
Copy Markdown
Member

merci Ashley. c'est incroyable.

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 hackathon-24 Contributions during the SpikeInterface Hackathon May 24

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants