refactor: update sync model helper function docs and minor cleanup

[navinkarkera]

Addresses comments from #36553

[openedx-webhooks]

Thanks for the pull request, @navinkarkera!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[ormsbee]

@navinkarkera: Please just squash your fixup commits. Thank you!

[pomegranited]

Looks cleaner now thank you @navinkarkera !

One nit about code duplication, but doesn't have to block merging.

👍

• I tested this while testing openedx/frontend-app-authoring#1865, and verified that a modified date gets set on a block's search index entry when the block is updated.
• I read through the code
• I checked for accessibility issues N/A
• Includes documentation N/A
• User-facing strings are extracted for translation N/A

[navinkarkera]

@ormsbee Done.

@pomegranited If you are talking about code duplication in ComponentLink and ContainerLink classes, it is not easy to avoid due to different field names: upstream_block -> upstream_container, upstream_usage_key -> upstream_container_key etc.

Also, in the latest commit: 237ba1c, I had to move all properties and methods to child classes due to the same issue.

[pomegranited]

@navinkarkera

If you are talking about code duplication in ComponentLink and ContainerLink classes, it is not easy to avoid due to different field names: upstream_block -> upstream_container, upstream_usage_key -> upstream_container_key etc.

Ah I see.. no worries! 👍

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.