protocolbuffers / protocolbuffers/protocolbuffers.github.io

C++ API docs out of date?

オープン
#287 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
HTML
スター
69
フォーク
179
PR マージ指標
30日以内にマージされた PR はありません

説明

The C++ API documentation does not appear to mirror the new absl::string_view return types introduced in v30.

https://protobuf.dev/support/migration/#string_view-return-type - describes the change in return types
https://protobuf.dev/reference/cpp/api-docs/google.protobuf.descriptor/#Descriptor - indicates returning const std::string&
https://github.com/protocolbuffers/protobuf/blob/01331f9e51775b7e11f8b61d778ea98ddb522ad1/src/google/protobuf/descriptor.h#L362 - returns absl::string_view

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

移行ガイドを、Descriptor ページの C++ API ドキュメントおよび参照されている descriptor.h の 362 行目と比較してください。ドキュメントに記載された戻り値の型のうち、absl::string_view を使用する v30 のシグネチャと異なるものを確認し、該当する API ドキュメントを更新して、各ページが一貫してヘッダーを反映していることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
cpp
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。