Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

linting #64

Merged
merged 2 commits into from
Nov 14, 2023
Merged

linting #64

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87eca7b
linting
plcplc Nov 14, 2023
e3cf8e9
Update specification/src/tutorial/schema.md
paf31 Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions specification/src/specification/queries/sorting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To compute the ordering from the `order_by` field, data connectors should implem
- For each [`OrderByElement`](../../reference/types.md#orderbyelement):
- If `element.target.type` is `column`, then to compare two rows, compare the value in the selected column. See type `column` below.
- If `element.target.type` is `star_count_aggregate`, compare two rows by comparing the row count of a related collection. See type `star_count_aggregate` below.
- If `element.target.type` is `single_count_aggregate`, compare two rows by comparing a single column aggregate. See type `single_count_aggregate` below.
- If `element.target.type` is `single_column_aggregate`, compare two rows by comparing a single column aggregate. See type `single_column_aggregate` below.

### Type `column`

Expand Down Expand Up @@ -53,9 +53,9 @@ For example, this query sorts article authors by their total article count:
{{#include ../../../../ndc-reference/tests/query/order_by_aggregate/request.json:3: }}
```

### Type `single_count_aggregate`
### Type `single_column_aggregate`

An ordering of type `single_count_aggregate` orders rows by an aggregate computed over rows in some [related collection](./relationships.md). If the respective aggregates are incomparable, the ordering should continue to the next [`OrderByElement`](../../reference/types.md#orderbyelement).
An ordering of type `single_column_aggregate` orders rows by an aggregate computed over rows in some [related collection](./relationships.md). If the respective aggregates are incomparable, the ordering should continue to the next [`OrderByElement`](../../reference/types.md#orderbyelement).

For example, this query sorts article authors by their maximum article ID:

Expand Down
4 changes: 2 additions & 2 deletions specification/src/specification/schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ See [`SchemaResponse`](../../reference/types.md#schemaresponse)
| `scalar_types` | [Scalar Types](scalar-types.md) |
| `object_types` | [Object Types](object-types.md) |
| `collections` | [Collection](collections.md) |
| `functions` | [Functions](Functions.md) |
| `procedures` | [Procedures](procedures.md) |
| `functions` | [Functions](functions.md) |
| `procedures` | [Procedures](procedures.md) |
2 changes: 1 addition & 1 deletion specification/src/tutorial/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Schema

The [schema endpoint](../specification/schema/README.md) should return data describing the data connector's scalar and object types, along with any collections, functions and procedures which are exposed.
The [schema endpoint](../specification/schema/index.html) should return data describing the data connector's scalar and object types, along with any collections, functions and procedures which are exposed.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is the right way to link in our markdown setup (i.e., it looks like it's confusing sources and compiled outputs, but the link that ended up in the compiled html still referenced a README.md, which is wrong)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a known bug rust-lang/mdBook#984.

I don't think fixing it with a link to .html is really better, because it will break the link in the original markdown for anyone reading on GitHub (not recommended, but still).

There is a script in the issue to work around this, but I would say let's just remove this link for now.

paf31 marked this conversation as resolved.
Show resolved Hide resolved

```rust,no_run,noplayground
{{#include ../../../ndc-reference/bin/reference/main.rs:schema1}}
Expand Down