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

More explanations and visualisations are needed #29

Open
lauraporta opened this issue Oct 24, 2024 · 0 comments
Open

More explanations and visualisations are needed #29

lauraporta opened this issue Oct 24, 2024 · 0 comments

Comments

@lauraporta
Copy link
Member

Is your feature request related to a problem? Please describe.

  1. Rotation + Derotation is very confusing to people
    Now that I am introducing the Rotator class, it is harder to keep in mind how it works in comparison to the derotation. I also get confused when explaining it to people.
  2. The interplay of incremental and full rotation is also very confusing.
  3. It's not clear how to re-create the images used in regression tests.

Describe the solution you'd like
Text:

  • longer docstrings, blocks of descriptions at the top of the files.
  • Expand the content of the readme:
    • describe how exactly all the modules work
    • move the content to documentation (docs folder)

Animations:

  • in the documentation, include plots and animations.
@lauraporta lauraporta mentioned this issue Oct 24, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant