Skip to content

fix(docs): correct stale flush() docstrings and restore before_galileo examples (SAO-16166) - #232

Open
etserend wants to merge 1 commit into
mainfrom
fix/SAO-16166-flush-docstring-corrections
Open

fix(docs): correct stale flush() docstrings and restore before_galileo examples (SAO-16166)#232
etserend wants to merge 1 commit into
mainfrom
fix/SAO-16166-flush-docstring-corrections

Conversation

@etserend

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #217 (HYBIM-966). PR #217 removed stale flush() calls from examples but did not update the four public docstrings its description promised, and incorrectly removed logger.flush() from the galileo "Before" migration snippets.

  • singleton.py / decorator.py — four docstrings: replace "upload and clear" / "Upload all captured traces" with drain-only wording
  • splunk-ao-migration-tool/examples/before_galileo.py — restore logger.flush() # uploads traces (galileo's flush genuinely uploads; the line correctly shows what callers remove when migrating)
  • splunk-ao-migration-tool/README.md — same restoration in the Before (galileo) block; After (splunk-ao) block is unchanged

No behavior changes. Docs and docstrings only.

Closes https://splunk.atlassian.net/browse/SAO-16166

🤖 Generated with Claude Code

…o examples (SAO-16166)

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@etserend
etserend requested a review from fercor-cisco August 25, 2026 02:35
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.

1 participant