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

Return values of GetDefaults and other getters #3333

Open
IiroAhokainen opened this issue Oct 10, 2024 · 1 comment
Open

Return values of GetDefaults and other getters #3333

IiroAhokainen opened this issue Oct 10, 2024 · 1 comment
Assignees
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Enhancement New functionality, model or documentation

Comments

@IiroAhokainen
Copy link
Contributor

Calling GetDefaults() with any neuron model returns a dictionary of default parameters. There are entries that are specific to the called neuron model (actual parameters of the model) but also more generic entries, such as 'available', 'elementsize', and 'node_uses_wfr.' While some of these generic entries are self-explanatory, not all of them might be for new users. Finding documentation for these elements is difficult. The documentation is scattered on different pages if even it exists.

Would it be possible to add a documentation page where all these generic elements are explained?

@IiroAhokainen IiroAhokainen added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Oct 10, 2024
Copy link

Issue automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Enhancement New functionality, model or documentation
Projects
Status: To do
Development

No branches or pull requests

2 participants