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.

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

fix some typos #5039

Merged
merged 1 commit into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion site/src/main/paradox/Builtin.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ sc.run().waitUntilDone()

Any `SCollection` of 2-tuples is considered a _keyed_ `SCollection` and the various @ref[joins](Joins.md) and `*ByKey` variants of other methods become available.
The first item in the tuple is considered the key and the second item the value.
The @scaladoc[keyBy](com.spotify.scio.values.SCollection#keyBy[K](f:T=%3EK)(implicitevidence$22:com.spotify.scio.coders.Coder[K]):com.spotify.scio.values.SCollection[(K,T)]) method creates a keyed `SCollection`, where the user-defined function extracts the key from the exising values:
The @scaladoc[keyBy](com.spotify.scio.values.SCollection#keyBy[K](f:T=%3EK)(implicitevidence$22:com.spotify.scio.coders.Coder[K]):com.spotify.scio.values.SCollection[(K,T)]) method creates a keyed `SCollection`, where the user-defined function extracts the key from the existing values:

```scala mdoc:compile-only
import com.spotify.scio.values.SCollection
Expand Down
4 changes: 2 additions & 2 deletions site/src/main/paradox/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Any Scala or Java unit testing frameworks can be used with Scio, but we provide
- @scaladoc[SCollectionMatchers](com.spotify.scio.testing.SCollectionMatchers) - ScalaTest matchers for `SCollection`
- @scaladoc[PipelineSpec](com.spotify.scio.testing.PipelineSpec) - shortcut for ScalaTest `FlatSpec` with utilities and matchers

The best place to find example useage of `JobTest` and `SCollectionMatchers` are their respective tests in @github[JobTestTest](/scio-test/src/test/scala/com/spotify/scio/testing/JobTestTest.scala) and @github[SCollectionMatchersTest](/scio-test/src/test/scala/com/spotify/scio/testing/SCollectionMatchersTest.scala).
The best place to find example usage of `JobTest` and `SCollectionMatchers` are their respective tests in @github[JobTestTest](/scio-test/src/test/scala/com/spotify/scio/testing/JobTestTest.scala) and @github[SCollectionMatchersTest](/scio-test/src/test/scala/com/spotify/scio/testing/SCollectionMatchersTest.scala).
For more examples see:

- @github[scio-examples](/scio-examples/src/test/scala/com/spotify/scio/examples)
Expand Down Expand Up @@ -361,7 +361,7 @@ def main(cmdlineArgs: Array[String]): Unit = {

#### How do I reduce Datastore boilerplate?

Datastore `Entity` class is actually generated from @github[Protobuf](/scio-examples/src/test/scala/com/spotify/scio/examples/extra/MagnolifyDatastoreExampleTest.scala) which uses the builder pattern and very boilerplate heavy. You can use the [Magnolify](https://github.com/spotify/magnolify) library to seamlessly convert bewteen case classes and `Entity`s. See @extref[MagnolifyDatastoreExample.scala](example:MagnolifyDatastoreExample) for an example job and @github[MagnolifyDatastoreExampleTest.scala](/scio-examples/src/test/scala/com/spotify/scio/examples/extra/MagnolifyDatastoreExampleTest.scala) for tests.
Datastore `Entity` class is actually generated from @github[Protobuf](/scio-examples/src/test/scala/com/spotify/scio/examples/extra/MagnolifyDatastoreExampleTest.scala) which uses the builder pattern and very boilerplate heavy. You can use the [Magnolify](https://github.com/spotify/magnolify) library to seamlessly convert between case classes and `Entity`s. See @extref[MagnolifyDatastoreExample.scala](example:MagnolifyDatastoreExample) for an example job and @github[MagnolifyDatastoreExampleTest.scala](/scio-examples/src/test/scala/com/spotify/scio/examples/extra/MagnolifyDatastoreExampleTest.scala) for tests.

#### How do I throttle Bigtable writes?

Expand Down