Skip to content

Commit 0b1d3de

Browse files
Add missing deprecation comments (#1482)
1 parent 4643705 commit 0b1d3de

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

src/utilities/extendSchema.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ type Options = {|
6868
* Descriptions are defined as preceding string literals, however an older
6969
* experimental version of the SDL supported preceding comments as
7070
* descriptions. Set to true to enable this deprecated behavior.
71+
* This option is provided to ease adoption and will be removed in v16.
7172
*
7273
* Default: false
7374
*/

src/utilities/schemaPrinter.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,17 @@ import {
3838
} from '../type/directives';
3939
import { isIntrospectionType } from '../type/introspection';
4040

41-
type Options = {| commentDescriptions?: boolean |};
41+
type Options = {|
42+
/**
43+
* Descriptions are defined as preceding string literals, however an older
44+
* experimental version of the SDL supported preceding comments as
45+
* descriptions. Set to true to enable this deprecated behavior.
46+
* This option is provided to ease adoption and will be removed in v16.
47+
*
48+
* Default: false
49+
*/
50+
commentDescriptions?: boolean,
51+
|};
4252

4353
/**
4454
* Accepts options as a second argument:

0 commit comments

Comments
 (0)