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

Misleading docstring and type hints in beam class methods #238

Closed
Hespe opened this issue Aug 19, 2024 · 0 comments · Fixed by #284
Closed

Misleading docstring and type hints in beam class methods #238

Hespe opened this issue Aug 19, 2024 · 0 comments · Fixed by #284
Labels
documentation Improvements or additions to documentation

Comments

@Hespe
Copy link
Member

Hespe commented Aug 19, 2024

The docstrings, parameter names and type hints of some beam class methods are not consistent with the new coordinate system. In particular, the from_twiss() method refers to sigma_s and its docstrings for sigma_p disagrees with from_parameters() about its unit.

Furthermore, the num_particles parameter of ParticleBeam methods is supposed to be a torch.Tensor according to its type hint, but the methods crash if a tensor is provided and a standard integer works.

@Hespe Hespe added the documentation Improvements or additions to documentation label Sep 2, 2024
@Hespe Hespe linked a pull request Oct 22, 2024 that will close this issue
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant