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

fixing various typos in pynest docs #816

Merged
merged 3 commits into from Sep 5, 2017

Conversation

@jessica-mitchell
Copy link
Collaborator

@jessica-mitchell jessica-mitchell commented Aug 26, 2017

Some minor corrections to the pynest documentation brought to my attention a couple of weeks ago.

Copy link
Contributor

@jougs jougs left a comment

Many thanks for addressing these issues. Apart from a small comment they are good to go.

As this only concerns documentation, I'll merge as soon as my remarks are addressed.

@@ -75,7 +75,7 @@ One such command is `nest.Models()`, which will return a list of all the
available models you can use. If you want to obtain more information about a
particular command, you may use Python’s standard help system.

nest.Models?
nest.Models()

This comment has been minimized.

@jougs

jougs Aug 30, 2017
Contributor

Actually, we really want the question mark here, which shows the help for nest.Models (() would execute it). However, because ? is an IPython built-in, we should probably change the Python in line 76 to IPython

This comment has been minimized.

@aserenko

aserenko Dec 6, 2017
Contributor

Sorry for interrupting, but, @jessica-mitchell and jougs, you might have been wrong about line 74, because this sentence says will return a list of all the available models you can use, which obviously refers to Models(). Still, the next mention of Models (you may use IPython's standard help system) at line 78 should indeed be with the question mark.


nest.Models?
nest.Models?

This comment has been minimized.

@jougs

jougs Sep 5, 2017
Contributor

Thanks for changing.
Unfortunately there are still two little problems:

  • the i in iPython needs to be upper-case
  • there's a trailing whitespace in line 78, which needs to go away.

Sorry for being so niggling about this!

This comment has been minimized.

@jessica-mitchell

jessica-mitchell Sep 5, 2017
Author Collaborator

No problem, thanks for your help

@jougs
jougs approved these changes Sep 5, 2017
Copy link
Contributor

@jougs jougs left a comment

Thanks for your contribution. The changes now look good to me and I'll merge immediately.

@jougs jougs merged commit e223579 into nest:master Sep 5, 2017
1 check was pending
1 check was pending
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@jessica-mitchell jessica-mitchell deleted the jessica-mitchell:minor_doc_corrections branch Jun 6, 2019
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

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