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

Include registry examples in pysat tutorial #837

Closed
aburrell opened this issue Jul 7, 2021 · 1 comment · Fixed by #840
Closed

Include registry examples in pysat tutorial #837

aburrell opened this issue Jul 7, 2021 · 1 comment · Fixed by #840

Comments

@aburrell
Copy link
Member

aburrell commented Jul 7, 2021

Is your feature request related to a problem? Please describe.
I frequently forget how to register instruments in pysat, since I don't do it often. The first place I look is in the pysat docs tutorial (basics and params), but nothing there is helpful. Instead, I always end up going to the index, searching for register, and ending up in the API section.

Describe the solution you'd like
An example of how to register instruments in the tutorial. Ideally in either basics or params, since I usually look there.

Describe alternatives you've considered
Adding a link to the API in the tutorial, since the API example is fine for me. But this might not be clear for other users.

Additional context
Registration is an important step and one that isn't performed frequently so needs clear and easy to find documentation.

@rstoneback
Copy link
Collaborator

A link to the registry and an example was added to tutorial_basics.

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

Successfully merging a pull request may close this issue.

2 participants