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

FIX: Final tweaks leading up to 1.0 release #3

Merged
merged 10 commits into from
Jun 19, 2024
Merged

Conversation

AlexanderLontke
Copy link
Contributor

@AlexanderLontke AlexanderLontke commented Jun 19, 2024

Description:
This pull request addresses several issues identified in the current release candidate v1.0rc2. The changes focus on improving the stability, readability, and user experience of the codebase. The following fixes have been implemented:

  1. Move Optional Dependencies into Try-Except Statement:

    • Commit: FIX: Move optional dependencies into try-except statement (1ebe8ea)
    • Description: This change ensures that optional dependencies are only imported if available, preventing runtime errors if these dependencies are missing. This is achieved by wrapping the import statements in a try-except block, allowing the program to handle the absence of optional packages gracefully.
  2. Update Log Throttler Doc Strings:

    • Commit: FIX: Updated log throttler doc strings (928d216, cd2de1e)
    • Description: The documentation strings for the log throttler have been updated to conform to formatting standards.
  3. Remove Warnings When Running Tests:

    • Commit: FIX: Removed warnings when running tests (476e1d0)
    • Description: This fix addresses several warnings that were being generated during the test execution. By resolving these warnings, the test output is now cleaner, making it easier to identify real issues and maintain a high-quality codebase.
  4. Remove Warnings When Running Tests:

  • Commits: Exclude artkit.api from sphinx doc build (e16df41, 1d8d666)
  • Description: Addresses warnings during sphinx build stemming from module structure.

Changes Made:

  • Wrapped optional dependency imports in try-except blocks.
  • Updated documentation for log throttler with detailed docstrings.
  • Resolved test warnings to ensure clean test runs.

Testing:

  • Verified that the application handles the absence of optional dependencies without crashing.
  • Ensured that the updated docstrings are correctly formatted and built without issue.
  • Ran the test suite to confirm that all tests pass without warnings.

@AlexanderLontke AlexanderLontke added the bug Something isn't working label Jun 19, 2024
@AlexanderLontke AlexanderLontke self-assigned this Jun 19, 2024
@j-ittner j-ittner changed the title FIX: Clean up issues with current release candidate v1.0rc2 FIX: Final tweaks leading up to 1.0 release Jun 19, 2024
@j-ittner j-ittner added this to the 1.0 milestone Jun 19, 2024
@j-ittner j-ittner added the documentation Improvements or additions to documentation label Jun 19, 2024
@breakbotz breakbotz self-requested a review June 19, 2024 20:25
@breakbotz breakbotz merged commit 19ab84b into 1.0.x Jun 19, 2024
11 checks passed
@j-ittner j-ittner deleted the fix/cleanup-1.0rc2 branch June 19, 2024 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants