🐛 fix: streamline rendered action hints (#46)

Co-authored-by: Codex <codex@openai.com>

Author: Nyako Shigure

skills/github-conversation/SKILL.md

@@ -29,8 +29,9 @@ GitHub stores the body text exactly as sent.
 1. Do not write multi-paragraph bodies as literal escape sequences such as `\n` or `\n\n`.
 2. If you send `--body 'line1\n\nline2'`, GitHub may store the backslashes literally, and the rendered review/comment will show `\n\n`.
 3. Use `--body` only for short single-paragraph text.
-4. For quotes, bullets, code fences, or multiple paragraphs, prefer `--body-file` with a file or `-` on standard input.
-5. For review suggestions that span multiple lines, prefer `--suggestion-file`.
+4. In the command patterns documented by this skill, every write action that accepts `--body` also has a `--body-file` form.
+5. For quotes, bullets, code fences, or multiple paragraphs, prefer `--body-file` with a file or `-` on standard input.
+6. For review suggestions that span multiple lines, prefer `--suggestion-file`.
 
 Safe patterns:
 

src/gh_llm/github_api.py

@@ -2990,12 +2990,7 @@ def _render_review_thread_block(
     resolve_cmd = display_command_with(f"pr thread-resolve {thread_id} --pr {ref.number} --repo {ref.owner}/{ref.name}")
     lines.append(f"  ◌ thread_id: {thread_id}")
     lines.append("  ⌨ reply_body: '<reply>'")
-    lines.append("  ⌨ reply_body_file: '<reply.md>'")
     lines.append(f"  ⏎ Reply via {display_command()}: `{reply_cmd}`")
-    lines.append(
-        "  ⏎ Multi-line reply via "
-        + f"{display_command()}: `{display_command_with(f'pr thread-reply {thread_id} --body-file <reply.md> --pr {ref.number} --repo {ref.owner}/{ref.name}')}`"
-    )
     if is_resolved:
         lines.append(f"  ⏎ Unresolve via {display_command()}: `{unresolve_cmd}`")
     else:
@@ -3161,14 +3156,9 @@ def _render_review_comment_block(
         edit_cmd = display_command_with(
             f"pr comment-edit {comment_id} --body '<comment_body>' --pr {ref.number} --repo {ref.owner}/{ref.name}"
         )
-        edit_file_cmd = display_command_with(
-            f"pr comment-edit {comment_id} --body-file <comment.md> --pr {ref.number} --repo {ref.owner}/{ref.name}"
-        )
         lines.append(f"  ◌ comment_id: {comment_id}")
         lines.append("  ⌨ comment_body: '<comment_body>'")
-        lines.append("  ⌨ comment_body_file: '<comment.md>'")
         lines.append(f"  ⏎ Edit comment via {display_command()}: `{edit_cmd}`")
-        lines.append(f"  ⏎ Multi-line edit via {display_command()}: `{edit_file_cmd}`")
 
     if not body and not diff_hunk:
         lines.append("  (empty review comment)")

src/gh_llm/render.py

@@ -161,8 +161,6 @@ def render_pr_actions(context: TimelineContext, *, include_diff: bool = True, in
             [
                 "⌨ comment_body: '<comment_body>'",
                 f"⏎ Comment via gh: `gh pr comment {context.number} --repo {repo} --body '<comment_body>'`",
-                "⌨ comment_body_file: '<path-or->'",
-                f"⏎ Multi-line comment via gh: `gh pr comment {context.number} --repo {repo} --body-file <path-or->`",
                 *close_or_reopen_lines,
                 "⌨ labels_csv: '<label1>,<label2>'",
                 f"⏎ Add labels via gh: `gh pr edit {context.number} --repo {repo} --add-label '<label1>,<label2>'`",
@@ -188,8 +186,6 @@ def render_issue_actions(context: TimelineContext) -> list[str]:
         "## Actions",
         "⌨ comment_body: '<comment_body>'",
         f"⏎ Comment via gh: `gh issue comment {context.number} --repo {repo} --body '<comment_body>'`",
-        "⌨ comment_body_file: '<path-or->'",
-        f"⏎ Multi-line comment via gh: `gh issue comment {context.number} --repo {repo} --body-file <path-or->`",
         *close_or_reopen_lines,
         "⌨ labels_csv: '<label1>,<label2>'",
         f"⏎ Add labels via gh: `gh issue edit {context.number} --repo {repo} --add-label '<label1>,<label2>'`",
@@ -424,14 +420,9 @@ def _render_item(index: int, event: TimelineEvent, context: TimelineContext, com
             edit_cmd = display_command_with(
                 f"{command_group} comment-edit {event.editable_comment_id} --body '<comment_body>' --{selector_name} {context.number} --repo {context.owner}/{context.name}"
             )
-            edit_file_cmd = display_command_with(
-                f"{command_group} comment-edit {event.editable_comment_id} --body-file <comment.md> --{selector_name} {context.number} --repo {context.owner}/{context.name}"
-            )
             lines.append(f"   ◌ comment_id: {event.editable_comment_id}")
             lines.append("   ⌨ comment_body: '<comment_body>'")
-            lines.append("   ⌨ comment_body_file: '<comment.md>'")
             lines.append(f"   ⏎ Edit comment via {display_command()}: `{edit_cmd}`")
-            lines.append(f"   ⏎ Multi-line edit via {display_command()}: `{edit_file_cmd}`")
     else:
         lines.extend(_indent_block(display_summary))
     if event.resolved_hidden_count > 0:

tests/test_cli.py

@@ -558,22 +558,22 @@ def test_view_and_expand_use_real_cursor_pagination(
     assert "## Checks" in out
     assert "[IN_PROGRESS/NONE] unit-tests (check-run)" in out
     assert "passed checks hidden." in out
+    assert "⌨ comment_body: '<comment_body>'" in out
     assert "gh pr comment 77928 --repo PaddlePaddle/Paddle --body '<comment_body>'" in out
-    assert "gh pr comment 77928 --repo PaddlePaddle/Paddle --body-file <path-or->" in out
     assert "gh pr close 77928 --repo PaddlePaddle/Paddle" in out
+    assert "⌨ labels_csv: '<label1>,<label2>'" in out
     assert "gh pr edit 77928 --repo PaddlePaddle/Paddle --add-label '<label1>,<label2>'" in out
     assert "gh pr edit 77928 --repo PaddlePaddle/Paddle --remove-label '<label1>,<label2>'" in out
+    assert "⌨ reviewers_csv: '<reviewer1>,<reviewer2>'" in out
     assert "gh pr edit 77928 --repo PaddlePaddle/Paddle --add-reviewer '<reviewer1>,<reviewer2>'" in out
+    assert "⌨ assignees_csv: '<assignee1>,<assignee2>'" in out
     assert "gh pr edit 77928 --repo PaddlePaddle/Paddle --add-assignee '<assignee1>,<assignee2>'" in out
     assert "link:" not in out
     assert (
         "Edit comment via gh-llm: `gh-llm pr comment-edit c3 --body '<comment_body>' --pr 77928 --repo PaddlePaddle/Paddle`"
         in out
     )
-    assert (
-        "Multi-line edit via gh-llm: `gh-llm pr comment-edit c3 --body-file <comment.md> --pr 77928 --repo PaddlePaddle/Paddle`"
-        in out
-    )
+    assert "⌨ comment_body: '<comment_body>'" in out
 
     pre_expand_calls = len(responder.calls)
     code = cli.run(["pr", "timeline-expand", "2", "--pr", "77928", "--repo", "PaddlePaddle/Paddle", "--page-size", "2"])
@@ -618,15 +618,12 @@ def test_view_and_expand_use_real_cursor_pagination(
         "Edit comment via gh-llm: `gh-llm pr comment-edit PRRC_self_1 --body '<comment_body>' --pr 77928 --repo PaddlePaddle/Paddle`"
         in out
     )
-    assert "reply_body_file: '<reply.md>'" in out
     assert (
-        "Multi-line reply via gh-llm: `gh-llm pr thread-reply PRRT_mock_1 --body-file <reply.md> --pr 77928 --repo PaddlePaddle/Paddle`"
-        in out
-    )
-    assert (
-        "Multi-line edit via gh-llm: `gh-llm pr comment-edit PRRC_self_1 --body-file <comment.md> --pr 77928 --repo PaddlePaddle/Paddle`"
+        "Reply via gh-llm: `gh-llm pr thread-reply PRRT_mock_1 --body '<reply>' --pr 77928 --repo PaddlePaddle/Paddle`"
         in out
     )
+    assert "⌨ comment_body: '<comment_body>'" in out
+    assert "⌨ reply_body: '<reply>'" in out
     assert "Unresolve via gh-llm:" in out
 
     code = cli.run(
@@ -1525,20 +1522,19 @@ def test_issue_view_and_expand_use_real_cursor_pagination(
     assert "(comment hidden: outdated)" in out
     assert "run `gh-llm issue comment-expand ic1 --issue 77924 --repo PaddlePaddle/Paddle` for full comment" in out
     assert "## Actions" in out
+    assert "⌨ comment_body: '<comment_body>'" in out
     assert "gh issue comment 77924 --repo PaddlePaddle/Paddle --body '<comment_body>'" in out
-    assert "gh issue comment 77924 --repo PaddlePaddle/Paddle --body-file <path-or->" in out
     assert "gh issue close 77924 --repo PaddlePaddle/Paddle" in out
+    assert "⌨ labels_csv: '<label1>,<label2>'" in out
     assert "gh issue edit 77924 --repo PaddlePaddle/Paddle --add-label '<label1>,<label2>'" in out
     assert "gh issue edit 77924 --repo PaddlePaddle/Paddle --remove-label '<label1>,<label2>'" in out
+    assert "⌨ assignees_csv: '<assignee1>,<assignee2>'" in out
     assert "gh issue edit 77924 --repo PaddlePaddle/Paddle --add-assignee '<assignee1>,<assignee2>'" in out
     assert (
         "Edit comment via gh-llm: `gh-llm issue comment-edit ic2 --body '<comment_body>' --issue 77924 --repo PaddlePaddle/Paddle`"
         in out
     )
-    assert (
-        "Multi-line edit via gh-llm: `gh-llm issue comment-edit ic2 --body-file <comment.md> --issue 77924 --repo PaddlePaddle/Paddle`"
-        in out
-    )
+    assert "⌨ comment_body: '<comment_body>'" in out
     assert "cross-reference by @alice (Alice)" in out
     assert "gh-llm pr view 77900 --repo PaddlePaddle/Paddle" in out
     assert "issue/closed by @ShigureNyako" in out