fix(docs): remove contradictory job_id note from monitor_progress doc… - #148
Merged
Merged
Conversation
…string Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
etserend
force-pushed
the
fix/monitor-progress-docstring-contradiction
branch
from
July 27, 2026 20:11
0f4d171 to
efc2835
Compare
Member
@etserend Should we take this opportunity to completely remove cc: @fercor-cisco |
fercor-cisco
left a comment
fercor-cisco
left a comment
Collaborator
There was a problem hiding this comment.
🤖 This review was generated by the Astra agent (claude-opus-4-8). It may contain mistakes.
Verdict: approve — Docstring-only fix that removes an inaccurate, self-contradictory note; verified against the actual signature and behavior.
Follow-ups
Suggested follow-up work that could be tracked as Shortcut stories:
src/splunk_ao/experiment.py:1144-1146: Reviewer (adityamehra) asked whether to fully remove the deprecatedjob_idparameter rather than only cleaning up its docs. Consider a follow-up to drop the parameter entirely once a deprecation window has elapsed, removing the keyword-only arg and the associated DeprecationWarning handling at lines 1171-1177.
1 task
fercor-cisco
approved these changes
Jul 28, 2026
fercor-cisco
left a comment
fercor-cisco
left a comment
Collaborator
There was a problem hiding this comment.
I created https://splunk.atlassian.net/browse/HYBIM-931 for removing job_id as a follow up.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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 poll_interval_seconds description told callers to use job_id= as a keyword argument, while the job_id entry immediately below marked it as deprecated and ignored. Removed the misleading sentence.