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

API reference documentation inaccurate #192

Open
samiransen23 opened this issue Aug 9, 2022 · 1 comment
Open

API reference documentation inaccurate #192

samiransen23 opened this issue Aug 9, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@samiransen23
Copy link
Contributor

samiransen23 commented Aug 9, 2022

  1. Several API reference documentations of HyMD have been naïvely copied or left unchanged though the functions are different.
  2. Some parameters are part of a list, while others are list of lists. Python documentation loosely suggests to care about the dimensionality only for numpy arrays but I'd rather avoid confusion by being explicit.
    Example: phi : list[pmesh.pm.RealField] but phi_fourier :list[ list[pmesh.pm.ComplexField], 3] and not phi_fourier : list[pmesh.pm.ComplexField]
@samiransen23 samiransen23 added the documentation Improvements or additions to documentation label Aug 9, 2022
@hmcezar
Copy link
Member

hmcezar commented Aug 9, 2022

Good point, we should definitely check and make the documentation consistent with the actual objects.

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

No branches or pull requests

2 participants