Skip to content

Commit

Permalink
Fix punctuation in some algorithms (graphql#1067)
Browse files Browse the repository at this point in the history
  • Loading branch information
yaacovCR authored Dec 14, 2023
1 parent 56d6107 commit feac5a5
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
5 changes: 5 additions & 0 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,8 @@ hyphens) should be capitalized, with the following exceptions:
All elements in hyphenated words follow the same rules, e.g. headings may
contain `Non-Null`, `Context-Free`, `Built-in` (`in` is a preposition, so is not
capitalized).

## Lists

Lists can be written as full sentences or as fragments. Algorithms that appear
as lists, however, should be written in full sentences with proper punctuation.
4 changes: 2 additions & 2 deletions spec/Section 2 -- Language.md
Original file line number Diff line number Diff line change
Expand Up @@ -1120,7 +1120,7 @@ ListValue : [ Value+ ]
- For each {Value+}
- Let {value} be the result of evaluating {Value}.
- Append {value} to {inputList}.
- Return {inputList}
- Return {inputList}.

### Input Object Values

Expand Down Expand Up @@ -1168,7 +1168,7 @@ ObjectValue : { ObjectField+ }
- Let {name} be {Name} in {field}.
- Let {value} be the result of evaluating {Value} in {field}.
- Add a field to {inputObject} of name {name} containing value {value}.
- Return {inputObject}
- Return {inputObject}.

## Variables

Expand Down
4 changes: 2 additions & 2 deletions spec/Section 3 -- Type System.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ IsInputType(type) :
- Return IsInputType({unwrappedType})
- If {type} is a Scalar, Enum, or Input Object type:
- Return {true}
- Return {false}
- Return {false}.

IsOutputType(type) :

Expand All @@ -363,7 +363,7 @@ IsOutputType(type) :
- Return IsOutputType({unwrappedType})
- If {type} is a Scalar, Object, Interface, Union, or Enum type:
- Return {true}
- Return {false}
- Return {false}.

### Type Extensions

Expand Down
4 changes: 2 additions & 2 deletions spec/Section 5 -- Validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -1014,7 +1014,7 @@ is a validation error if the target of a spread is not defined.

- For each {fragmentDefinition} in the document:
- Let {visited} be the empty set.
- {DetectFragmentCycles(fragmentDefinition, visited)}
- {DetectFragmentCycles(fragmentDefinition, visited)}.

DetectFragmentCycles(fragmentDefinition, visited):

Expand All @@ -1023,7 +1023,7 @@ DetectFragmentCycles(fragmentDefinition, visited):
- {visited} must not contain {spread}.
- Let {nextVisited} be the set including {spread} and members of {visited}.
- Let {nextFragmentDefinition} be the target of {spread}.
- {DetectFragmentCycles(nextFragmentDefinition, nextVisited)}
- {DetectFragmentCycles(nextFragmentDefinition, nextVisited)}.

**Explanatory Text**

Expand Down
2 changes: 1 addition & 1 deletion spec/Section 6 -- Execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ CreateSourceEventStream(subscription, schema, variableValues, initialValue):
is unaffected if an alias is used.
- Let {field} be the first entry in {fields}.
- Let {argumentValues} be the result of {CoerceArgumentValues(subscriptionType,
field, variableValues)}
field, variableValues)}.
- Let {fieldStream} be the result of running
{ResolveFieldEventStream(subscriptionType, initialValue, fieldName,
argumentValues)}.
Expand Down

0 comments on commit feac5a5

Please sign in to comment.