Add a first iteration containing documentation of design. #257
Conversation
Specifically, this iteration focuses on explaining the rationale behind the Schema construct, and provides an explanation for a subset of the possible schemas
There was a problem hiding this comment.
I was editing this in the IDE so I don't have proper github suggestions, enjoy a commit instead:
Added a lot of newlines so that future diffs look less cluttered (shorter lines, and it renders the same in the HTML). Also my editor likes to trim trailing whitespace on lines so that also affects the size of the diff...
| @@ -0,0 +1,14 @@ | |||
| --- | |||
There was a problem hiding this comment.
dunno if it's a file naming thing, but it'd look better as "Design" (uppercase D)
|
|
||
| Indeed, for each field, there is an associated reference to a schema (int, string, ...), a string label, and a lambda calling the case class accessor that allows the retrieval of the associated field value. Additionally, the constructor of the case class is also referenced in the Schema. | ||
|
|
||
| Typically, the accessors are needed for encoding the data, which involves destructuring it to access its individual components. The labels are there to cater to serialisation mechanisms like Json or Xml, which apply some labelled nesting on component data. |
There was a problem hiding this comment.
which apply some labelled nesting on component data
I'm not quite clear what is meant by this
There was a problem hiding this comment.
I've rephrased, let me know how it reads
Jakub's improvements on design documentation [skip ci]
|
@lewisjkl since Jakub had provided a commit that impacted your suggestions, I've taken the liberty of removing your comments containing only amendments, after making sure they were addressed. |
Specifically, this iteration focuses on explaining the rationale behind the Schema construct, and provides an explanation for a subset of the possible schemas