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

Further update models #12

Conversation

sarakonradi
Copy link

This PR is based on nest#1374 and further updates the model files.

It:

  • Ensures keywords are consistently written in singular form
  • Writes out abbreviations (e.g. AC and DC)
  • Updates the Device name
  • Adds an empty line between EndUserDocs and the class definition
  • Corrects model names, such as iaf_psc_exp_htum

Copy link

@jougs jougs left a comment

Choose a reason for hiding this comment

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

Many thanks! This looks mostly good to me :-)

For the future, could you please @mention me (by writing @jougs in the description of the PR or a comment somewhere) when you're doing these kinds of things? That way I'd be alerted by email when something is ready for me to look at without any need to communicate that via other means. Thanks!

@@ -46,7 +46,7 @@ ac_generator
Description
+++++++++++

This device produces an ac-current sent by a CurrentEvent. The
This device produces an AC current sent by a CurrentEvent. The
Copy link

Choose a reason for hiding this comment

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

Suggested change
This device produces an AC current sent by a CurrentEvent. The
This device produces AC input sent by CurrentEvents. The

Reasoning: AC already has a 'current' in it, cf. PIN number, LCD display, ...

@@ -58,8 +58,8 @@ Parameters

FirstVersion: June 2017

Transmits
+++++++++
Sends
Copy link

Choose a reason for hiding this comment

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

This needs to stay Transmits. Also in other files ending in _connection.h.

The logic is that neurons have the (single) event type they will send during the simulation under Sends and all event types they are able to handle under Receives. As synapses/connections only relay the events from the sender to the receiver, the have everything they can relay under Transmits.


Description
+++++++++++

The DC-Generator provides a constant DC Input to the connected node. The unit of the current is pA.
The dc_generator provides a constant DC Input to the connected node. The unit of the current is pA.
Copy link

Choose a reason for hiding this comment

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

Suggested change
The dc_generator provides a constant DC Input to the connected node. The unit of the current is pA.
The dc_generator provides a constant DC input to the connected node. The unit of the current is pA.

@sarakonradi
Copy link
Author

@jougs Thanks for your suggestions!

I added the AC input, DC input and Transmits changes.

RAS syndrome can be painful. Hence, I removed the repetitions.

@jougs
Copy link

jougs commented Feb 12, 2020

Great!

Can you please again pull jessica-mitchell:update_models_rst_format into your branch and fix the conflicts? From my side this would then be good to go.

@jougs
Copy link

jougs commented Feb 14, 2020

@jessica-mitchell: could you please merge this? I'm fine with the changes now.
@sarakonradi: Merging this one into the branch nest#1374 is based off should make Travis happy.

@jessica-mitchell jessica-mitchell merged commit 60caee6 into jessica-mitchell:update_models_rst_format Mar 4, 2020
jessica-mitchell pushed a commit that referenced this pull request May 11, 2021
jessica-mitchell pushed a commit that referenced this pull request Feb 25, 2022
jessica-mitchell pushed a commit that referenced this pull request Mar 16, 2022
Remove Vera++ checks and update clang-format to only version 9
jessica-mitchell pushed a commit that referenced this pull request Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants