Skip to content

Conversation

@yoshiyuki-140
Copy link
Collaborator

概要

README.mdの古い情報を最新の実装に合わせて更新しました。主に、コマンドライン引数の仕様変更(2引数→3引数)に関する記述を修正し、機能説明の正確性を向上させました。

関連Issue

変更内容

  • コマンドライン引数を<operator> <digits>から<operator> <left_digits> <top_digits>に修正
  • 実行例を3引数形式に更新(より実用的な例を追加)
  • コマンドライン引数の表にleft_digitstop_digitsを分けて記載
  • 桁数の範囲を「1桁~4桁まで」と明記
  • 非対称な桁数指定機能(左側と上側で異なる桁数)について記載
  • 解答PDFも生成されることを明記
  • 出力ファイル名の形式を2keta.pdfから2x1keta.pdf形式に修正
  • git cloneコマンドの余分な閉じ括弧)を削除(タイポ修正)

スクリーンショット

N/A(ドキュメント更新のみ)

変更前

python main.py <operator> <digits>

変更後

python main.py <operator> <left_digits> <top_digits>

動作確認項目

  • ローカル環境で動作確認済み
  • 必要なテストを追加/更新済み(ドキュメント変更のみのため該当なし)
  • テストが全て成功することを確認済み
  • Lintエラーがないことを確認済み(ドキュメントファイルのため該当なし)

レビュー時の注意点

  • README.mdの記述がmain.pyの実装(3つの位置引数:operator, left_digits, top_digits)と完全に一致していることを確認してください
  • issue#16およびissue#17で実装された機能(非対称な桁数指定、解答PDF生成)がREADMEに正しく反映されていることを確認してください
  • サンプルPDFのリンク先が実在するファイル(./sample/hyakumasu_たしざん_2x1keta.pdf)であることを確認してください

その他

この変更により、README.mdと実際のコードの不整合が解消され、新規ユーザーが正しい使い方を理解できるようになります。

@yoshiyuki-140 yoshiyuki-140 changed the title docs: ✏️ issue/16とissue/17の変更内容をREADME.mdに反映 Issue19 : #16と #17 の変更内容をREADME.mdに反映 Nov 9, 2025
@yoshiyuki-140 yoshiyuki-140 changed the title Issue19 : #16と #17 の変更内容をREADME.mdに反映 Issue19 : issue/16と issue/17 の変更内容をREADME.mdに反映 Nov 9, 2025
@yoshiyuki-140 yoshiyuki-140 self-assigned this Nov 9, 2025
@yoshiyuki-140 yoshiyuki-140 added the documentation Improvements or additions to documentation label Nov 9, 2025
@yoshiyuki-140 yoshiyuki-140 requested a review from emi-12d November 9, 2025 04:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feat✨] #15 の変更点をREADME.mdに反映する

2 participants