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

Example on front page hard to follow #363

Closed
dstansby opened this issue May 13, 2021 · 1 comment
Closed

Example on front page hard to follow #363

dstansby opened this issue May 13, 2021 · 1 comment

Comments

@dstansby
Copy link
Contributor

I am coming to gwcs as a first time user, and thought the first two narrative sections on the documentation page (https://gwcs.readthedocs.io/en/latest) were a great introduction to gwcs.

I found the example in the third section (A step by step example of constructing an imaging GWCS object.) hard to follow though, because it is focused on precisely replicating a fitswcs, instead of explaining the concepts and API of constructing a gwcs.

My suggestion for improvement would be to move this example out of the introductory section, and replace it with a simple example that uses only one transformation step, but still shows how the gwcs API works in practice.

@perrygreenfield
Copy link
Collaborator

Addressed by #483

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

No branches or pull requests

3 participants