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

improve docstrings in Autoupload enum #243

Merged
merged 5 commits into from
Jan 10, 2025

Conversation

denniswittich
Copy link
Contributor

Rephrases the docstrings in the Autoupload enum to better reflect its role as a configuration type rather than an active component.

Changes:

  • Rewrites class docstring to describe the enum's purpose as configuration options
  • Changes member docstrings from action statements to descriptive mode definitions
  • Removes misleading implications about the enum performing actions itself

The enum is a pure type definition, and these changes make its purpose clearer to developers.

@NiklasNeugebauer NiklasNeugebauer added this to the 0.22.0 milestone Jan 8, 2025
@denniswittich
Copy link
Contributor Author

@NiklasNeugebauer Did you check if this variant still works e.g. on ubuntu 22?

@NiklasNeugebauer
Copy link
Contributor

NiklasNeugebauer commented Jan 10, 2025

@NiklasNeugebauer Did you check if this variant still works e.g. on ubuntu 22?

tests are running fine without libgl.
The Docker image works with the new packages, though I also doubt it really needs the libraries.
If anyone has other specific needs, like for OpenCV visualization, they should have this expressed in their system configuration or Dockerfile.

@NiklasNeugebauer NiklasNeugebauer merged commit 577a170 into main Jan 10, 2025
5 checks passed
@NiklasNeugebauer NiklasNeugebauer deleted the improve-docstrings-for-Enum-Autoupload branch January 10, 2025 16:49
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.

2 participants