printSchema: not valid comments

[hendrul]

I must be doing something wrong, no one else seems to complain... my schema is being printed with comments with wrong syntax like...

"""
A signed eight-byte integer. The upper big integer values are greater then the
max value for a JavaScript number. Therefore all big integers will be output as
strings and not numbers.
"""
scalar BigInt

the expected syntax is

# A signed eight-byte integer. The upper big integer values are greater then the
# max value for a JavaScript number. Therefore all big integers will be output as
# strings and not numbers.
scalar BigInt

[hendrul]

Ohh I see, it has an undocumented option "commentDescriptions"

// Generates comments right
printSchema(schema, { commentDescriptions: true })

[galki]

did that option work for you? ok its gotta be true, not false

[IvanGoncharov]

the expected syntax is

@hendrul Version 0.13.0 introduced some breaking changes to SDL syntax, see here:
https://github.com/graphql/graphql-js/releases/tag/v0.13.0

commentDescriptions was added as an option to provide the backward compatible format of descriptions.

[hendrul]

Ok I see, cool!, now this option needs to be known

[leebyron]

This behavior has been around since v0.12 and was documented in the release notes!
https://github.com/graphql/graphql-js/releases/tag/v0.12.0

Note that the block string is the correct syntax for descriptions in the SDL - we used to use comments before we had a completed specification for this feature.