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

Describe "phase" parameter in astropy.modeling.functional_models.Sine1D and astropy.modeling.functional_models.Cosine1D #16470

Open
janerigby opened this issue May 17, 2024 · 1 comment
Labels
Docs Feature Request good first issue Issues that are well-suited for new contributors modeling

Comments

@janerigby
Copy link
Contributor

What is the problem this feature will solve?

The documentation for astropy.modeling.functional_models.Sine1D should describe the units of the "phase" parameter. Since it does not, its not clear to the user whether that parameter has the same units of the x-axis (which I would call an x-offset, not a phase), or is it phase in the sense of an angular offset (units of degrees or radians).

Describe the desired outcome

Add description of the "phase" parameter to the documentation of Cosine1D and Sine1D, including units

Additional context

No response

@nden nden added the good first issue Issues that are well-suited for new contributors label May 17, 2024
@nden
Copy link
Contributor

nden commented May 17, 2024

Looking at the issue and the code that added it, it was meant as an x- offset. I'm labeling this as a good issue for first time contributors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Feature Request good first issue Issues that are well-suited for new contributors modeling
Projects
None yet
Development

No branches or pull requests

3 participants