Skip to content

[docs] Document REPL multi-line input continuation (/help + user guide) #51

Description

@Kewton

概要

REPL の複数行入力(継続入力)は実装済みだが、/help にも利用者ガイドにも一切記載が無く、偶然以外に発見できない。/helpdocs/guide(en/ja)に記載を追加する。コード変更は /help 文言のみの小型 Issue。

検証環境: develop f8b2d6cdocs/guide 配下に multi-line / backslash の記載が無いことを grep で確認済み。

現状と証跡

実装済みの挙動(src/tui/editor.rs):

  • 行末が \、または " が閉じていない状態で Enter すると継続入力になり、... 継続プロンプトが表示される(input_needs_continuation: editor.rs:438-442CONTINUATION_PROMPT: editor.rs:21、validator: editor.rs:426-434)。
  • 確定時は normalize_multiline_inputeditor.rs:444-460)が行末 \ を除去し、改行を空白1つに連結して1行のコマンドとして実行する。
  • bracketed paste が有効(editor.rs:92-101)なので、複数行テキストの貼り付けは即実行されず、確定時に同様に空白連結される。

未記載の場所:

  • /helpsrc/tui/slash.rs:579-599 render_help)— footer / 実行中入力 / 割り込みの説明はあるが継続入力の説明が無い。
  • docs/guide/en / docs/guide/ja — 該当記述なし。

期待動作

  1. /help に1行追加(英語・既存トーンに合わせる)。例:
    Multi-line: end a line with \\ or leave a \" unclosed to continue on the next line (\"... \" prompt); pasted newlines are joined with spaces on submit.
  2. docs/guide/endocs/guide/ja の REPL 節に「複数行入力」小節を追加し、次の4点を記載する(両言語でパリティを保つ):
    • 行末 \ による継続
    • 未閉クォートによる継続
    • ... 継続プロンプトの意味
    • 複数行貼り付けは確定時に空白1つで連結されること

受け入れ基準

  • /help 出力に継続入力の説明が含まれる。
  • docs/guide/en / docs/guide/ja の両方に同内容の節があり、EN/JA パリティが保たれている。
  • tests/doc_drift.rsrender_help の内容を固定している(doc_drift.rs:94,120,128 付近)。ヘルプ文言変更に合わせて drift 側の期待値・対応ドキュメントを更新し、テストを通す。
  • cargo fmt --all -- --check / cargo clippy --all-targets -- -D warnings / cargo test

スコープ境界(非目標)

  • 継続入力仕様そのものの変更(Shift+Enter 対応等は別議論)
  • README への追記(任意。行うなら README.md / README.ja.md 同時更新で doc-drift を通すこと)

関連Issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions