Skip to content

Commit

Permalink
typo in 01-design.md
Browse files Browse the repository at this point in the history
  • Loading branch information
combinatorist authored and Baccata committed Feb 4, 2025
1 parent f733cc5 commit e5b88d4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion modules/docs/markdown/05-design/01-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Before we dive in to the design elements, it is important to state that Smithy4s
Therefore, following the protocol-agnostic nature of smithy, the code generated by Smithy4s is not biased towards any protocol or serialisation mechanism, nor any runtime or Scala version.
* **optimised for correctness over compatibility**: there is strictly no guarantee made regarding backward compatibility of the generated code when users evolve their smithy schemas.
Therefore, users are expected to regenerate the code at use-site, instead of relying on artifacts that would contain the generated code... However, users do get idiomatic Scala code, including case classes / sealed traits (which are notoriously hard to evolve in binary compatible ways), and this generated code correctly reflects the smithy specifications.
* **decoupled from third-party libraries**: the generated code depends only on smithy4s-core for compilation, which does not pull third-party dependencies (not even a general purpose libraries that the maintainers love, like cats)
* **decoupled from third-party libraries**: the generated code depends only on smithy4s-core for compilation, which does not pull third-party dependencies (not even general purpose libraries that the maintainers love, like cats)

These constraints may sound counter-intuitive, obtuse, even alien. The internals of this library are not beginner friendly. They rely on advanced features of the Scala compiler that may unfortunately scare away newcomers interested in contributing. If you're not discouraged yet, do not hesitate to ask questions using github discussions, we will do our best to answer them!

0 comments on commit e5b88d4

Please sign in to comment.