Skip to content

Document Empty Recorder Output #782

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

Open
varndorfer opened this issue Jan 31, 2025 · 0 comments
Open

Document Empty Recorder Output #782

varndorfer opened this issue Jan 31, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@varndorfer
Copy link
Contributor

If no events are recorded for a given element, then no output is produced by the recorders (ex: XMLRecorder::saveSimData()). This can be confusing for new users, for example, when you run a short Neuro simulation, only the endogenously active neurons will output spiking activity. New users may think there is something wrong with their configuration or the simulation because they are missing output for most of the neurons.

We should add documentation to clearly explain that elements will only display in the output if an event is recorded for that element.

@varndorfer varndorfer added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 31, 2025
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant