[Documentation] Missing documentation on the enum parsing feature

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

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

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
java
領域
documentation

調査の方向性

Issue にリンクされている Developer's Guide の JSON ページから始め、参照されている行の周辺にある FieldInfo.java を読んで、enum の解析動作と @Value および @NullValue アノテーションを理解してください。JSON ドキュメントに、これらのアノテーションを使って enum 型を @Key フィールドとして設定する方法を明確に説明する段落が含まれていれば完了です。

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

説明

priority: p3 type: feature request

I'm a google-http-client-jackson2 user, and I struggled a bit looking for a way to setup an enum type as a @Key.

This is the exception I was getting: IllegalArgumentException: given enum name New not part of enumeration

Eventually I was able to find that out myself by looking into the class FieldInfo, and I learned of the existence of the annotations @Value and @NullValue.

I'm opening this issue to please ask you to update the Developer's Guide (the JSON page in particular) with a new paragraph talking about those two annotations.

Thanks.

PS: I think this relates to #127

主要言語
Java
スター
1.4k
フォーク
476
平均マージ
10時間 47分
マージ済み PR(30日)
3

環境構築

はじめの一歩

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

googleapis/google-http-java-client のほかの issue

googleapis/google-http-java-client の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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