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

Better documentation for initializing a beam, links from object docs to tutorials #1200

Closed
bhazelton opened this issue Aug 15, 2022 · 1 comment
Assignees
Labels
beams docs documentation

Comments

@bhazelton
Copy link
Member

It's hard to initialize a beam from scratch right now, not enough description about how to start and then to run the check method. It's also annoying to have to set the axes length parameters in addition to setting the arrays. Maybe a easy_init class method where you pass the minimal set of info and it defaults all the rest sensibly?

Also, the write-ups we have are on the tutorials, need links to them from the object API docs.

interpolation method is not set by default but there's really only one option for each beam type. This should at least be made clear in the initialize description, could consider defaulting.

@bhazelton bhazelton added the docs documentation label Aug 15, 2022
@steven-murray steven-murray self-assigned this Aug 15, 2022
@bhazelton
Copy link
Member Author

This was fixed with a new UVBeam.new method in #1378.

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

No branches or pull requests

2 participants