Skip to content

Commit

Permalink
Merge pull request #20 from PSchmiedmayer/master
Browse files Browse the repository at this point in the history
Fix some small documentation typos and formatting errors
  • Loading branch information
nerdsupremacist authored May 27, 2020
2 parents 625c5c9 + def4d0a commit 6d366bb
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ private var propertiesForType = [Int : [String : PropertyInfo]]()

## Note

Input types can be useful to group arguments. We can also use them to group arguments that should always be provided together. Like in out search example, we don't need the user to specify how to sort. But when the user wants the Results sorted by a field, we need to know if ascending or descending. That's why the Input Object makes sense in this scenario.
Input types can be useful to group arguments. We can also use them to group arguments that should always be provided together. Like in our search example, we don't need the user to specify how to sort. But when the user wants the Results sorted by a field, we need to know if they should be sorted in an ascending or descending order. That's why the Input Object makes sense in this scenario.

## Details

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ import ContextKit
This API is modeled after standards set by [Relay](https://relay.dev/docs/en/pagination-container) and [GraphQL](https://graphql.org/learn/pagination/).

It relies on the usage of the arguments: `first`, `after`, `last` and `before`.

- Parameters:
- first: Number of items that will be fetched at the start of the list
- after: Cursor of the last element in the page that comes before. Signals that all items in the requested page should be strictly after the element with that cursor. The element with the cursor should be excluded
- last: Number of items that will be fetched at the end of the list
- before: Cursor of the first element in the page that comes after. Signals that all items in the requested page should be strictly before the element with that cursor. The element with the cursor should be excluded
- `first`: Number of items that will be fetched at the start of the list
- `after`: Cursor of the last element in the page that comes before. Signals that all items in the requested page should be strictly after the element with that cursor. The element with the cursor should be excluded
- `last`: Number of items that will be fetched at the end of the list
- `before`: Cursor of the first element in the page that comes after. Signals that all items in the requested page should be strictly before the element with that cursor. The element with the cursor should be excluded

## Note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ import ContextKit
This API is modeled after standards set by [Relay](https://relay.dev/docs/en/pagination-container) and [GraphQL](https://graphql.org/learn/pagination/).

It relies on the usage of the arguments: `first`, `after`, `last` and `before`.

- Parameters:
- first: Number of items that will be fetched at the start of the list
- after: Cursor of the last element in the page that comes before. Signals that all items in the requested page should be strictly after the element with that cursor. The element with the cursor should be excluded
- last: Number of items that will be fetched at the end of the list
- before: Cursor of the first element in the page that comes after. Signals that all items in the requested page should be strictly before the element with that cursor. The element with the cursor should be excluded
- `first`: Number of items that will be fetched at the start of the list
- `after`: Cursor of the last element in the page that comes before. Signals that all items in the requested page should be strictly after the element with that cursor. The element with the cursor should be excluded
- `last`: Number of items that will be fetched at the end of the list
- `before`: Cursor of the first element in the page that comes after. Signals that all items in the requested page should be strictly before the element with that cursor. The element with the cursor should be excluded

## Note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ public protocol OutputResolvable: Resolvable {

/**
Resolves the value that can be outputed to GraphQL

- Parameters:
- source: Parent of this type
- arguments: Arguments given to the parent field
- context; Context, containing additional runtime data about the resuts. You may also include additional information here for other nested types to use
- eventLoop; Event Loop Group that can be used for creating futures

- source: Parent of this type
- arguments: Arguments given to the parent field
- context: Context, containing additional runtime data about the resuts. You may also include additional information here for other nested types to use
- eventLoop: Event Loop Group that can be used for creating futures
- Returns: A Future with a value that can be evaluated by GraphQL.
*/
*/
func resolve(source: Any, arguments: [String : Map], context: MutableContext, eventLoop: EventLoopGroup) throws -> Future<Any?>
}

Expand Down

0 comments on commit 6d366bb

Please sign in to comment.