feat(format): format_to_nの戻り値の記述の詳細化

[teruyamato0731]

加えた変更

• 戻り値のオブジェクトが保持するメンバ変数の意味について、それぞれ記述しました
• 切り捨てが発生する場合のコード例を追加しました
• format_to_n_result.mdにおいて、出力イテレーターと記載がありましたが、イテレータ表記が主に用いられているようだったので、ーを削除しました。（なお他にイテレーター表記が用いられているのは、reference/ranges/concat_view.mdのみ）

悩んだ点

• issueでは以下の文章も加えていましたが、冗長だと判断したため、削除しました

  したがって、戻り値の`size`が引数`n`より大きい場合、出力が途中で切り捨てられたことを意味する。
  

• 戻り値の説明にある、(ただし、`N` =...）について、うまい表記が思いつかなかったため、何も変更を加えていません。これにより、新しく追加した記述と、二重で表記されているように思います
• 概要のコード例において、auto [end, n] = の記載がありますが、auto [out, size] = に統一すべきでしょうか？

close #1547

[github-actions]

⚡ プレビュー (HTML) (更新時刻: 2026-01-04 19:55:58 JST)

• ⫯ Commit: c2a62f3
• プレビューの生成には時間がかかります (3～5分)。進捗状況はこちらをご確認ください。

変更記事一覧

2件の記事が変更されました。

• 📝 reference/format/format_to_n
• 📝 reference/format/format_to_n_result

※ソース (.md) に直接変更のあった記事を列挙しています。グローバル修飾や変換規則の変更による変化は考慮していません。

[faithandbrave]

修正ありがとうございます。ひとまずマージしちゃいますね。

[faithandbrave]

• 戻り値の説明にある、(ただし、N =...）について、うまい表記が思いつかなかったため、何も変更を加えていません。これにより、新しく追加した記述と、二重で表記されているように思います
• 概要のコード例において、auto [end, n] = の記載がありますが、auto [out, size] = に統一すべきでしょうか？

これらは追々、裁量の範囲でよい表現に変更してもらえればよいかと思います。
書き方はある程度統一されていた方が文書としてきれいという考え方もあるでしょうし、いろいろな書き方の選択肢があると知れるのもよいかとも思います。

[faithandbrave]

あ、すいません。 @teruyamato0731 さん、初Pull Requestでしたね。
Working Teamに招待させていただきました。のちほどGitHubから招待の通知が届くと思います。以降はmasterブランチで直接作業していただいて大丈夫です。もしよろしければ今後ともよろしくお願いします。

[teruyamato0731]

なんと！ありがとうございます。
いつもcpprefjpにはお世話になっているので、参加できて光栄です。
今後ともよろしくお願いします。