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

Add GIF / GLIF acronyms to model title in documentation #2365

Merged
merged 5 commits into from
Apr 19, 2022

Conversation

jessica-mitchell
Copy link
Contributor

To help alleviate confusion between the two types of models, I've added the acronyms to the titles in the model userdocs section.

Not sure if further differentiation would be helpful (e.g., do we need to add a tag for leaky models?). @heplesser @diesmann perhaps have ideas.

@jessica-mitchell jessica-mitchell added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Apr 4, 2022
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Apr 4, 2022
@clinssen
Copy link
Contributor

clinssen commented Apr 4, 2022

Thank you for the PR. This is just an unfortunate naming clash (or almost-clash, GIF vs. GLIF). Both models are leaky (virtually all models in neuroscience are leaky, so I would not make a separate tag for this). If we want to disambiguate further, perhaps we could include the authors' (or first author's) name in the model name; or "Allen Institute" for GLIF.

@jessica-mitchell
Copy link
Contributor Author

OK thanks @clinssen I kind of thought it was common, but was just going based on name :D.
If it's agreed that adding Allen Institute is helpful then we could add it to the title of GLIF models. Especially if that's a search term people might use ctl+f for.

Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

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

@jessica-mitchell I added suggestions for slightly changed wording.

@diesmann @abigailm I'd much appreciate your comments on what would be the optimal way to make the source and thus nature of the GIF and GLIF models obvious to reduce the risk of confusion.

models/gif_cond_exp.h Outdated Show resolved Hide resolved
models/glif_cond.h Outdated Show resolved Hide resolved
jessica-mitchell and others added 2 commits April 11, 2022 22:54
Co-authored-by: Hans Ekkehard Plesser <hans.ekkehard.plesser@nmbu.no>
Documentation automation moved this from In progress to Review Apr 19, 2022
@heplesser heplesser merged commit 8ff2a7e into nest:master Apr 19, 2022
Documentation automation moved this from Review to Done Apr 19, 2022
@terhorstd terhorstd changed the title Add GIF / GLIF acronyms to model title in docs Add GIF / GLIF acronyms to model title in documentation Jul 20, 2022
@jessica-mitchell jessica-mitchell deleted the improve-glif-gif branch April 17, 2024 18:09
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 T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants