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 import statement to tutorial #62

Open
janerigby opened this issue Jan 17, 2018 · 1 comment
Open

Add import statement to tutorial #62

janerigby opened this issue Jan 17, 2018 · 1 comment

Comments

@janerigby
Copy link

In this tutorial:
pysynphot/doc/source/tutorials.rst
it would be extremely helpful to new users to add the import statement:
import pysynphot as S

As a brand-new user, it took me 10 minutes of googling to figure out what "S" is. The tutorial should include all import statements that are necessary for the tutorial to worl.

@pllim
Copy link
Collaborator

pllim commented Jan 17, 2018

Hi. Thank you for your interest in this package.

There are such instructions under the index.html page of http://pysynphot.readthedocs.io/en/latest/ (about half way down) and at the start of the tutorials page, it asks user to look at that part of index.html first. However, I agree that it is not the most straightforward solution.

Feel free to open a pull request to suggest where in tutorials.rst to insert the import statement in a way that is clear to you.

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

No branches or pull requests

2 participants