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

Added gap junction Markdown documentation #608

Merged
merged 2 commits into from Jan 5, 2017

Conversation

@janhahne
Copy link

@janhahne janhahne commented Dec 27, 2016

As discussed in the meeting on 19.12. this PR adds a markdown documentation file simulations-with-gap-junctions.md to the documentation explaining the use of gap junctions in NEST 2.12.

I suggest @steffengraber (is everything in the right place?) and @jschuecker (is the documentation understandable?) as reviewers.

janhahne
@janhahne janhahne force-pushed the janhahne:gap_junction_docu branch from e1a21b5 to ee336a2 Dec 27, 2016
@steffengraber
Copy link
Collaborator

@steffengraber steffengraber commented Jan 2, 2017

👍 from my side. Documentation and examples are on the right place.

nest.Connect(a, b, {'rule': 'one_to_one'}, {'model': 'gap_junction', 'weight': 0.5})
nest.Connect(b, a, {'rule': 'one_to_one'}, {'model': 'gap_junction', 'weight': 0.5})
```

This comment has been minimized.

@jschuecker

jschuecker Jan 3, 2017
Contributor

It might be dangerous to start with code lines which are actually not working, in particular if the user quickly wants to look up the call and does not read the whole documentation. I would suggest to skip the lines 16 to 28 and directly start with the correct function call. If you think these lines are necessary you could put them as a note after the correct call (around line 50) and say something like "these lines would in principle lead to the same gap junction connection but are forbidden in NEST 2.12 to prevent the user from creating incomplete gap junctions and thus result in an error."

@jschuecker
Copy link
Contributor

@jschuecker jschuecker commented Jan 3, 2017

@janhahne: nice and clear documentation, I have only one issue (see my in line comment).

@janhahne
Copy link
Author

@janhahne janhahne commented Jan 4, 2017

@jschuecker Thank you for the good suggestion. I removed the first script and it indeed improved readability. Could you have another look and approve the PR if you are satisfied?

janhahne
@janhahne janhahne force-pushed the janhahne:gap_junction_docu branch from db99b12 to 6fa7d30 Jan 4, 2017
@jschuecker
Copy link
Contributor

@jschuecker jschuecker commented Jan 5, 2017

@janhahne I had a look again, 👍 from my side.

@heplesser heplesser merged commit 65f8e40 into nest:master Jan 5, 2017
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@janhahne janhahne deleted the janhahne:gap_junction_docu branch Jan 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.