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.

Sign up for GitHub

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

Jump to bottom

Documentation for recording spike times is obtuse #3070

Closed
WillemWybo opened this issue Jan 18, 2024 · 2 comments · Fixed by #3159
Closed

Documentation for recording spike times is obtuse #3070

WillemWybo opened this issue Jan 18, 2024 · 2 comments · Fixed by #3159
Assignees
@jessica-mitchell
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: High Should be handled next T: Enhancement New functionality, model or documentation

Comments

@WillemWybo
Copy link
Contributor

Describe the flaw
The main spike_recorder documentation page doesn't mention that there is an 'events' attribute containing the spike times. I had to click through two times to backends to find it here.

Suggest an improvement
Describe the attribute on the main docs page

Supporting materials
https://nest-simulator.readthedocs.io/en/latest/models/spike_recorder.html
@terhorstd terhorstd added T: Enhancement New functionality, model or documentation S: High Should be handled next I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Jan 19, 2024
@heplesser
Copy link
Contributor

In context withe readers for our file output, I created some documentation of the file format here:
NeuralEnsemble/python-neo#1097 (review)

It applies correspondingly to the entries of the events dictionary and may be useful as a starting point for better documentation.

@jessica-mitchell jessica-mitchell mentioned this issue Mar 18, 2024
Merged
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 2, 2024

Issue automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Apr 2, 2024
@jessica-mitchell jessica-mitchell removed the stale Automatic marker for inactivity, please have another look here label Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jessica-mitchell jessica-mitchell

Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: High Should be handled next T: Enhancement New functionality, model or documentation
Projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clarify documentation related to recorders and recording backends jessica-mitchell/nest-simulator
4 participants
@heplesser @jessica-mitchell @WillemWybo @terhorstd