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 help text #913

Merged
merged 6 commits into from Apr 16, 2018

Conversation

Projects
None yet
3 participants
@babsey
Contributor

babsey commented Mar 19, 2018

The purpose of the PR is that the function 'help' is able to return text about an object instead of opening in a pager.

Example:
txt = nest.help('iaf_psc_alpha', return_text=True)
print txt

@heplesser

Looks generally fine, just two small comments in the code.

Show outdated Hide outdated pynest/nest/lib/hl_api_info.py
Show outdated Hide outdated pynest/nest/lib/hl_api_helper.py

@heplesser heplesser requested a review from steffengraber Mar 20, 2018

@jougs

jougs approved these changes Apr 16, 2018

LGTM and merging. Many thanks for the contribution.

@jougs jougs merged commit a3335b9 into nest:master Apr 16, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@babsey babsey deleted the babsey:Return_help_text branch Apr 16, 2018

@babsey

This comment has been minimized.

Show comment
Hide comment
@babsey

babsey Apr 16, 2018

Contributor

Thanks for approving. However, few days ago I realized that the function load_help return either one or two variables, which is not a good programming.

In case that the file not found, the function doesnt return any variable. It might call an error, when for this output would split but it is not iterable (a,b = None).

I have already fixed that problem, but I will write solution codes in a new branch and pull the request to merge.

Contributor

babsey commented Apr 16, 2018

Thanks for approving. However, few days ago I realized that the function load_help return either one or two variables, which is not a good programming.

In case that the file not found, the function doesnt return any variable. It might call an error, when for this output would split but it is not iterable (a,b = None).

I have already fixed that problem, but I will write solution codes in a new branch and pull the request to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment