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.

Sign up for GitHub

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

Jump to bottom

DOC: improve IDIMethod documentation #10

Open
domengorjup opened this issue Feb 17, 2021 · 1 comment
Open

DOC: improve IDIMethod documentation #10

domengorjup opened this issue Feb 17, 2021 · 1 comment
Assignees
@domengorjup
Labels
enhancement New feature or request

Comments

@domengorjup
Copy link
Collaborator

Some IDI methods have lacking documentation.

For example, the LucasKanade.calculate_displacements docstring should give more information on the shape and other properties of the calculated displacements.

The documentation should be unified across other IDI methods as well, or perhaps clarified further in pyidi/idi_method.py.
@domengorjup domengorjup added the enhancement New feature or request label Feb 17, 2021
@domengorjup domengorjup self-assigned this Feb 17, 2021
@domengorjup
Copy link
Collaborator Author

For pyIDI.get_displacement: could the main properties (shape etc.) of the computed displacements be defined in this docstring, before appending the method-specific doumentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@domengorjup domengorjup

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@domengorjup