cpprefjp / site

cpprefjpサイトのMarkdownソース
https://cpprefjp.github.io/
381 stars 155 forks source link

ライブラリのリファレンスにも、その機能が導入された経緯・背景を書ける場所を用意したい #1244

Closed faithandbrave closed 8 months ago

faithandbrave commented 8 months ago

言語機能の方には、ひな形に見出しとして「この機能が必要になった背景・経緯」がありますが、ライブラリの方にはいまのところありません。

その機能が必要となる状況や、その機能を使わない・ない場合に不便であることの説明のためにも、ライブラリの方にもこの項目を追加したいと思うのですが、いかがでしょうか?

現在は書く場所がないので、ページによっては備考欄に書かれていることがあります。

yohhoy commented 8 months ago

基本的には賛同です。

(少し日和った意見ですが)同セクションの記述はオプション=書いてもよいし/書かなくてもよいとしておいたほうが、参加ハードルが下がるとは思います。

淡々とライブラリ仕様を書き下す作業コストに比べると、ライブラリ機能導入の背景・経緯を理解・要約するのはまた異なる作業コストという認識です。

faithandbrave commented 8 months ago

一人で完全なページを作ることは求めないという基本方針はありますが、ひな形に「余裕があったら書いてください」と書いておきましょうか

faithandbrave commented 8 months ago

関数、クラス、型、CPOのひな形に、「この機能が必要になった背景・経緯」を追加しました。備考の下です。