Skip to content

Commit

Permalink
[DOCS-2821] README: Remove class names in method refs (#162)
Browse files Browse the repository at this point in the history
Ticket(s): [DOCS-2821](https://faunadb.atlassian.net/browse/DOCS-2821)

 Removes class names from method references in text. This aligns with Google's [style recommendations](https://developers.google.com/style/code-in-text#method-names).
  • Loading branch information
jrodewig authored Jun 21, 2024
1 parent 93d21c8 commit ef3e39c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,11 @@ func main() {

## Pagination

Use the `Client.Paginate()` method to iterate sets that contain more than one page of results.
Use the `Paginate()` method to iterate sets that contain more than one page of results.

`Client.paginate()` accepts the same query options as `Client.Query()`.
`Paginate()` accepts the same query options as `Query()`.

Change the default items per page using FQL's `<set>.pageSize()` method.
Change the default items per page using FQL's `pageSize()` method.

```go
package main
Expand Down Expand Up @@ -292,7 +292,7 @@ to a set from a [supported
source](https://docs.fauna.com/fauna/current/reference/streaming_reference/#supported-sources).

To start and subscribe to the stream, pass a query that produces a stream token
to `Client.Stream()`:
to `Stream()`:

```go
type Product struct {
Expand Down Expand Up @@ -336,7 +336,7 @@ func main() {
In query results, the driver represents stream tokens as `fauna.Stream`
values.

To start a stream from a query result, call `Client.Subscribe()` on a
To start a stream from a query result, call `Subscribe()` on a
`fauna.Stream` value. This lets you output a stream alongside normal query
results:

Expand Down Expand Up @@ -409,10 +409,10 @@ func main() {
### Stream options

The [client configuration](#client-configuration) sets default query options for
`Client.Stream()`. To override these options, see [query
`Stream()`. To override these options, see [query
options](#query-options).

The `Client.Subscribe()` method accepts a `fauna.StartTime` function. You can
The `Subscribe()` method accepts a `fauna.StartTime` function. You can
use `fauna.StartTime` to restart a stream after disconnection.

```go
Expand Down

0 comments on commit ef3e39c

Please sign in to comment.