Better describe what `Coercing.valueToLiteral` is for

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

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

評価

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

調査の方向性

まず Coercing インターフェースの JavaDoc と、graphql-java.com/documentation/scalars/ にあるカスタムスカラーのドキュメントを読みます。valueToLiteral が何を受け取るのか、parseValue および serialize とどのような関係にあるのかを明確にし、カスタムスカラーのガイドにこのメソッドを記載します。両方のドキュメント箇所で、その目的と引数の形式が一貫して説明されていれば完了です。

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

説明

keep-open

While upgrading to GraphQL Java 21, I stumbled over the method valueToLiteral offered by the Coercing interface. So far, when implementing a custom scalar, I haven't bothered about implementing this method and have not encountered any problems so far although the default implementation throws an exception.

In the JavaDoc of the Coercing interface, it says that "every valid external input values for parseValue(Object) is also valid for valueToLiteral(Object) and vice versa" which suggest that the argument to valueToLiteral should be in serialized form. However, when looking at implementations of this method, I see that most often serialze is called first on the argument, which suggests otherwise.

Could you please improve the JavaDoc and also the documentation on custom scalars, which does not mention this method at all?

主要言語
Java
スター
6.2k
フォーク
1.1k
平均マージ
22分
マージ済み PR（30日）
14

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

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

はじめの一歩

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

graphql-java/graphql-java のほかの issue

graphql-java/graphql-java の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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