From 0b6abd192c5533e5c7ca62b46f2a3093fdf2fe90 Mon Sep 17 00:00:00 2001 From: msinton Date: Mon, 24 Jan 2022 09:05:57 +0000 Subject: [PATCH 1/2] spelling While "synthetize" is a correct spelling it appears to be an uncommon form of the word. (I initially thought incorrect) IMO "synthesize CLI tools" seems a little odd, would consider if this is really what is meant. --- modules/docs/src/01-overview/01-intro.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/docs/src/01-overview/01-intro.md b/modules/docs/src/01-overview/01-intro.md index fdc43717d..cb9b8a672 100644 --- a/modules/docs/src/01-overview/01-intro.md +++ b/modules/docs/src/01-overview/01-intro.md @@ -8,8 +8,8 @@ title: Intro smithy4s is a tool that generates third-party-free, protocol-agnostic scala code from smithy specifications. Smithy4s can be used to: -* quickly synthetise http/rest servers and clients -* synthetise pure-scala AWS clients -* synthetise CLI tools +* quickly synthesize http/rest servers and clients +* synthesize pure-scala AWS clients +* synthesize CLI tools * and has the potential for much, much more! From 197fd517217876e889b5159c46c2baf38dbd6ab3 Mon Sep 17 00:00:00 2001 From: Matt Sinton-Hewitt Date: Mon, 24 Jan 2022 14:49:30 +0000 Subject: [PATCH 2/2] Update wording, derive over synthetize --- modules/docs/src/01-overview/01-intro.md | 6 +++--- .../src/03-protocols/02-simple-rest-json/01-overview.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/docs/src/01-overview/01-intro.md b/modules/docs/src/01-overview/01-intro.md index cb9b8a672..9cb816556 100644 --- a/modules/docs/src/01-overview/01-intro.md +++ b/modules/docs/src/01-overview/01-intro.md @@ -8,8 +8,8 @@ title: Intro smithy4s is a tool that generates third-party-free, protocol-agnostic scala code from smithy specifications. Smithy4s can be used to: -* quickly synthesize http/rest servers and clients -* synthesize pure-scala AWS clients -* synthesize CLI tools +* quickly derive http/rest servers and clients +* derive pure-scala AWS clients +* derive CLI tools * and has the potential for much, much more! diff --git a/modules/docs/src/03-protocols/02-simple-rest-json/01-overview.md b/modules/docs/src/03-protocols/02-simple-rest-json/01-overview.md index c67a061c0..147a168a2 100644 --- a/modules/docs/src/03-protocols/02-simple-rest-json/01-overview.md +++ b/modules/docs/src/03-protocols/02-simple-rest-json/01-overview.md @@ -5,7 +5,7 @@ title: The SimpleRestJson protocol Smithy4s provides a custom Json-in/Json-out protocol that smithy services can be annotated with. -Smithy4s comes with opt-in http4s-specific module, that contains functions that are aware of this protocol, and can be used to quickly synthetise http services and clients. +Smithy4s comes with opt-in http4s-specific module, that contains functions that are aware of this protocol, and can be used to quickly derive http services and clients. As for the json aspect of the protocol, [jsoniter-scala](https://github.com/plokhotnyuk/jsoniter-scala/) is used for the (de)serialisation of the http bodies.