Skip to content

[text-auditor] Fix malformed suggestion-block docs and one misleading log-extractor description #653

@github-actions

Description

@github-actions

Text Improvements

The following user-facing text issues were found in the repository. Each is a low-effort fix.

1. Unclosed inline code span around suggestion block syntax (6 occurrences)

File: claude-workflows/pr-review/ro/action.yml (line 140)
Current text: ...provide code suggestions (via ```suggestion blocks in comments), ...
Suggested fix: ...provide code suggestions (via ```suggestion``` blocks in comments), ...
Why: The markdown/code marker is malformed, making the instruction harder to parse.

File: claude-workflows/pr-review/rwx/action.yml (line 139)
Current text: ...provide code suggestions (via ```suggestion blocks), ...
Suggested fix: ...provide code suggestions (via ```suggestion``` blocks), ...
Why: Same malformed syntax.

File: claude-workflows/pr-review/rwx/README.md (line 32)
Current text: - ✅ **Provide code suggestions** (via ```suggestion blocks)
Suggested fix: - ✅ **Provide code suggestions** (via ```suggestion``` blocks)
Why: Same malformed syntax.

File: workflows/pr-review/ro/action.yml (line 140)
Current text: ...provide code suggestions (via ```suggestion blocks in comments), ...
Suggested fix: ...provide code suggestions (via ```suggestion``` blocks in comments), ...
Why: Same malformed syntax.

File: workflows/pr-review/rwx/action.yml (line 139)
Current text: ...provide code suggestions (via ```suggestion blocks), ...
Suggested fix: ...provide code suggestions (via ```suggestion``` blocks), ...
Why: Same malformed syntax.

File: workflows/pr-review/rwx/README.md (line 32)
Current text: - ✅ **Provide code suggestions** (via ```suggestion blocks)
Suggested fix: - ✅ **Provide code suggestions** (via ```suggestion``` blocks)
Why: Same malformed syntax.

2. Log extractor description omits warnings even though warnings are matched

File: scripts/extract-log-errors.py (line 101)
Current text: Extract errors from GitHub Actions log files.
Suggested fix: Extract errors and warnings from GitHub Actions log files.
Why: The default patterns include ##[warning] (scripts/extract-log-errors.py, line 33), so the current help text understates actual behavior.

Suggested Actions

  • Replace malformed ```suggestion ... wording with ```suggestion``` ... in all 6 listed files.
  • Update extract-log-errors.py argparse description to mention both errors and warnings.

What is this? | From workflow: Trigger Text Auditor

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Mar 17, 2026, 1:43 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions