[FXC-7659] Added user guide ref to run control docstrings#2042
Merged
piotrkluba merged 1 commit intoMay 13, 2026
Conversation
marcvivesmassana
approved these changes
May 13, 2026
This was referenced May 13, 2026
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
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.
Note
Low Risk
Low risk documentation-only change that adds cross-references in docstrings; no runtime behavior or validation logic is modified.
Overview
Adds a user-guide cross-reference (
:ref:\Run Control `) to the docstrings forRunControlandStoppingCriterion` to make the API docs point readers to the run control overview.Reviewed by Cursor Bugbot for commit 09c3926. Bugbot is set up for automated code reviews on this repo. Configure here.