docs: explain the parse extension precondition

biomejs · May 21, 2024 · 61744b6 · 61744b6
1 parent 865a097
commit 61744b6
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/crates/biome_graphql_parser/src/parser/definitions/object.rs b/crates/biome_graphql_parser/src/parser/definitions/object.rs
@@ -33,6 +33,7 @@ pub(crate) fn parse_object_type_definition(p: &mut GraphqlParser) -> ParsedSynta
     Present(m.complete(p, GRAPHQL_OBJECT_TYPE_DEFINITION))
 }
 
+/// Must only be called if the next 2 token is `extend` and `type`, otherwise it will panic.
 #[inline]
 pub(crate) fn parse_object_type_extension(p: &mut GraphqlParser) -> ParsedSyntax {
     let m = p.start();

diff --git a/crates/biome_graphql_parser/src/parser/definitions/scalar.rs b/crates/biome_graphql_parser/src/parser/definitions/scalar.rs
@@ -24,6 +24,7 @@ pub(crate) fn parse_scalar_type_definition(p: &mut GraphqlParser) -> ParsedSynta
     Present(m.complete(p, GRAPHQL_SCALAR_TYPE_DEFINITION))
 }
 
+/// Must only be called if the next 2 token is `extend` and `scalar`, otherwise it will panic.
 #[inline]
 pub(crate) fn parse_scalar_type_extension(p: &mut GraphqlParser) -> ParsedSyntax {
     let m = p.start();

diff --git a/crates/biome_graphql_parser/src/parser/definitions/schema.rs b/crates/biome_graphql_parser/src/parser/definitions/schema.rs
@@ -33,6 +33,7 @@ pub(crate) fn parse_schema_definition(p: &mut GraphqlParser) -> ParsedSyntax {
     Present(m.complete(p, GRAPHQL_SCHEMA_DEFINITION))
 }
 
+/// Must only be called if the next 2 token is `extend` and `schema`, otherwise it will panic.
 #[inline]
 pub(crate) fn parse_schema_extension(p: &mut GraphqlParser) -> ParsedSyntax {
     let m = p.start();