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

Break the sync package into smaller packages/modules #121

Closed
danstis opened this issue Sep 6, 2023 · 0 comments · Fixed by #287
Closed

Break the sync package into smaller packages/modules #121

danstis opened this issue Sep 6, 2023 · 0 comments · Fixed by #287
Assignees
Labels
enhancement New feature or request

Comments

@danstis
Copy link
Owner

danstis commented Sep 6, 2023

As a developer, I want the code split into multiple packages, so related code is easier to find.

@danstis danstis added the enhancement New feature or request label Sep 6, 2023
@danstis danstis changed the title Break the sync package into smaller packages Break the sync package into smaller packages/modules Sep 9, 2023
@danstis danstis self-assigned this Sep 9, 2023
@danstis danstis linked a pull request Oct 4, 2024 that will close this issue
danstis added a commit that referenced this issue Oct 5, 2024
### **User description**
This pull request addresses issue #121 by breaking the sync package into smaller packages/modules. This change improves code organization and makes it easier to find related code.


___

### **PR Type**
Enhancement, Documentation


___

### **Description**
- Refactored the `sync.py` file to improve code organization by breaking down functions into smaller, more manageable parts and enhancing error handling by raising exceptions instead of returning.
- Removed redundant sections from docstrings to streamline documentation.
- Introduced helper functions to process backlog items and closed items, improving the readability and maintainability of the code.
- Added `# NOSONAR` comments in test files to suppress specific warnings.


___



### **Changes walkthrough** 📝
<table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
<tr>
  <td>
    <details>
      <summary><strong>sync.py</strong><dd><code>Refactor sync logic and improve error handling</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

ado_asana_sync/sync/sync.py

<li>Refactored functions to improve code organization and reduce <br>complexity.<br> <li> Removed redundant docstring sections.<br> <li> Enhanced error handling by raising exceptions.<br> <li> Added new helper functions for processing tasks.<br>


</details>


  </td>
  <td><a href="https://github.com/danstis/ado-asana-sync/pull/287/files#diff-bff1342bf72ee80994b9872da2e344d3c44c33ef075f942ee8a66c538f545b64">+240/-289</a></td>

</tr>                    
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
      <summary><strong>test_sync.py</strong><dd><code>Suppress sonar warnings in test_sync.py</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

tests/sync/test_sync.py

- Added `# NOSONAR` comments to suppress specific warnings.



</details>


  </td>
  <td><a href="https://github.com/danstis/ado-asana-sync/pull/287/files#diff-dac5b229e36d3c4af2b553d8166f028111f08257c36f93dfecb2929b1a2d2cf0">+2/-2</a>&nbsp; &nbsp; &nbsp; </td>

</tr>                    

<tr>
  <td>
    <details>
      <summary><strong>test_task_item.py</strong><dd><code>Suppress sonar warnings in test_task_item.py</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

tests/sync/test_task_item.py

- Added `# NOSONAR` comments to suppress specific warnings.



</details>


  </td>
  <td><a href="https://github.com/danstis/ado-asana-sync/pull/287/files#diff-960fbea415e87edb53e4658950b63a6a514be88b83eaea5906f3d7ff3b4b30da">+1/-1</a>&nbsp; &nbsp; &nbsp; </td>

</tr>                    
</table></td></tr></tr></tbody></table>

___

> 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull request to receive relevant information
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant