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

Inconsistent documentation for classes with .from_image_properties class method #233

Closed
iancze opened this issue Dec 9, 2023 · 0 comments · Fixed by #243
Closed

Inconsistent documentation for classes with .from_image_properties class method #233

iancze opened this issue Dec 9, 2023 · 0 comments · Fixed by #243

Comments

@iancze
Copy link
Collaborator

iancze commented Dec 9, 2023

Describe the bug
The documentation for several routines is inconsistent between the __init__ and from_image_properties calls. Some document coords. Many from_image_properties calls are undocumented.

  • mpol.gridding.DirtyImager
  • mpol.gridding.DataAverager
  • mpol.fourier.NuFFT
  • possibly others

Suggested fix
Document the from_image_properties and check the __init__ call is consistent with the remaining arguments.

Or, remove the from_image_properties calls entirely. Is this a feature we actually use? I find more often than not that it is more concise to instantiate a GridCoords object and then pass that to routines needed.

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