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

Refactor UnityAssetSyncTask to RefreshUnityAssetsTask with Updated Naming and Documentation #28

Merged
merged 1 commit into from
Aug 20, 2024

Conversation

teogor
Copy link
Owner

@teogor teogor commented Aug 20, 2024

Overview

This pull request introduces a significant refactor of the existing UnityAssetSyncTask class, renaming it to RefreshUnityAssetsTask to better reflect its purpose and functionality. The changes include updates to the task's description, method names, and the addition of a companion object for task name management.

Summary of Changes:

  • Renamed Class and Methods:

    • The class UnityAssetSyncTask has been renamed to RefreshUnityAssetsTask to better describe its functionality of refreshing and updating Unity assets.
    • Updated method names and task descriptions accordingly.
  • Updated Documentation:

    • Revised class-level and method-level comments to match the new class name and task functionality.
    • Added a TASK_NAME constant in the companion object for consistent task name management.
  • Exception Handling:

    • Adjusted exception handling messages and documentation to align with the new class name and updated methods.
  • Task Registration:

    • Updated the task registration method to reflect the new task class name and constant for task identification.

Detailed Changes:

  • Class Renaming:

    • Changed UnityAssetSyncTask to RefreshUnityAssetsTask.
    • Updated the @see references in the comments to use the new class name.
  • Method Updates:

    • Renamed importContent to executeTask for clarity on the task's purpose.
    • Updated task description and method comments to reflect the new naming.
  • Documentation Enhancements:

    • Improved inline documentation for better clarity and alignment with the updated class and method names.
    • Added a companion object with a TASK_NAME constant for easier task identification.

@teogor teogor added @documentation Improvements or additions to documentation @enhancement New feature or request labels Aug 20, 2024
@teogor teogor added this to the 1.0.0-alpha03 milestone Aug 20, 2024
@teogor teogor self-assigned this Aug 20, 2024
@teogor teogor merged commit f426468 into main Aug 20, 2024
4 checks passed
@zeobot zeobot bot deleted the feature/refresh-unity-assets-task branch August 20, 2024 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@documentation Improvements or additions to documentation @enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

1 participant