docs(pull_mirror): fix incorrect start() method usage example #3275
+2
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR fixes incorrect documentation for the pull mirror start() method by correcting the example to show the proper API usage through the manager object rather than directly on the mirror instance.
- Corrected the
start()method invocation frommirror.start()toproject.pull_mirror.start() - Fixed grammar from "an sync" to "a sync" in the documentation comment
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
8d1efa1 to
aa1ac3d
Compare
nejch
approved these changes
Oct 17, 2025
The documentation incorrectly showed calling start() on the ProjectPullMirror object (mirror.start()), but the method only exists on the ProjectPullMirrorManager. Updated the example to show the correct usage: project.pull_mirror.start(). Fixes #3269
aa1ac3d to
9a4b655
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation incorrectly showed calling start() on the ProjectPullMirror object (mirror.start()), but the method only exists on the ProjectPullMirrorManager. Updated the example to show the correct usage: project.pull_mirror.start().
Fixes #3269