Skip to content

docs: Scatterers#315

Merged
giovannivolpe merged 8 commits into
DeepTrackAI:developfrom
Pwhsky:Scatterers-docs
Apr 8, 2025
Merged

docs: Scatterers#315
giovannivolpe merged 8 commits into
DeepTrackAI:developfrom
Pwhsky:Scatterers-docs

Conversation

@Pwhsky
Copy link
Copy Markdown
Collaborator

@Pwhsky Pwhsky commented Mar 11, 2025

  • Changed relative imports to absolute.
  • | instead of union type hints
  • Examples use import deeptrack as dt.
  • Method descriptions

Copy link
Copy Markdown
Contributor

@cmanzo cmanzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Replace Union[...] with | for compatibility with Python 3.10+.
  • Ensure all classes support both Image and np.ndarray, including lists of each (list[Image] and list[np.ndarray]).
  • Update type hints accordingly in method signatures and the Methods section of the docstring.
  • Use built-in generics (list, dict, etc.) instead of List, Dict, etc., and remove their imports from typing.
  • In Examples, always import deeptrack as dt and reference dt.Image, etc., instead of using Image directly.

Copy link
Copy Markdown
Contributor

@cmanzo cmanzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Methods are not described in the docstring

@Pwhsky Pwhsky changed the title Scatterers: absolute imports docs: Scatterers Mar 14, 2025
@giovannivolpe giovannivolpe merged commit fbf06c9 into DeepTrackAI:develop Apr 8, 2025
25 checks passed
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

Successfully merging this pull request may close these issues.

3 participants