Skip to content

[spec-extractor] Update package specifications for agentdrain, cli, console, constants#43173

Merged
pelikhan merged 1 commit into
mainfrom
spec-extractor/2026-07-03-1961dea6440c7466
Jul 3, 2026
Merged

[spec-extractor] Update package specifications for agentdrain, cli, console, constants#43173
pelikhan merged 1 commit into
mainfrom
spec-extractor/2026-07-03-1961dea6440c7466

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation-only update to two package READMEs, adding specifications for recently introduced symbols in pkg/console and pkg/constants.

Changes

pkg/console/README.md

  • Added four new stderr-TTY-aware format functions to the exports table and reference table:
    • FormatSuccessMessageStderr — success message checking os.Stderr TTY state
    • FormatInfoMessageStderr — info message checking os.Stderr TTY state
    • FormatListItemStderr — list entry checking os.Stderr TTY state
    • FormatSectionHeaderStderr — section header checking os.Stderr TTY state
  • Added a Stderr TTY Variants subsection explaining that *Stderr variants check os.Stderr (not os.Stdout) for terminal detection; callers writing directly to os.Stderr should use these to ensure correct color stripping in piped/non-interactive contexts.
  • Added a Go usage example for all four new variants.

pkg/constants/README.md

  • Added a File Permission Constants section documenting five new fs.FileMode values for consistent file and directory creation:
    • FilePermSensitive (0o600) — owner-only read/write (config files, credentials)
    • FilePermPublic (0o644) — owner read/write + world read (normal files)
    • FilePermExecutable (0o755) — owner/group/world executable (scripts, binaries)
    • DirPermSensitive (0o750) — owner+group access (sensitive directories)
    • DirPermPublic (0o755) — standard non-sensitive directory access

Scope

Documentation only — no Go source files modified. No behaviour changes.

Generated by PR Description Updater for #43173 · 35.3 AIC · ⌖ 6.28 AIC · ⊞ 4.7K ·

- console: document FormatSuccessMessageStderr, FormatInfoMessageStderr,
  FormatListItemStderr, FormatSectionHeaderStderr — the stderr-TTY-aware
  variants that check os.Stderr instead of os.Stdout before applying ANSI
  styling
- constants: document FilePermSensitive, FilePermPublic, FilePermExecutable,
  DirPermSensitive, DirPermPublic file mode constants

Packages analyzed this run: agentdrain, cli, console, constants

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation pkg-specifications labels Jul 3, 2026
@pelikhan pelikhan merged commit 07df146 into main Jul 3, 2026
@pelikhan pelikhan deleted the spec-extractor/2026-07-03-1961dea6440c7466 branch July 3, 2026 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation pkg-specifications

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant