Skip to content

[FXC-7659] Added user guide ref to run control docstrings#2042

Merged
piotrkluba merged 1 commit into
release-candidate/25.8from
piotr/run-control-docstring-update
May 13, 2026
Merged

[FXC-7659] Added user guide ref to run control docstrings#2042
piotrkluba merged 1 commit into
release-candidate/25.8from
piotr/run-control-docstring-update

Conversation

@piotrkluba
Copy link
Copy Markdown
Collaborator

@piotrkluba piotrkluba commented May 13, 2026

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 for RunControlandStoppingCriterion` 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.

@piotrkluba piotrkluba enabled auto-merge (squash) May 13, 2026 09:03
@piotrkluba piotrkluba merged commit 5fb255c into release-candidate/25.8 May 13, 2026
20 checks passed
@piotrkluba piotrkluba deleted the piotr/run-control-docstring-update branch May 13, 2026 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants