This repository has been archived by the owner on Mar 15, 2021. It is now read-only.
Few minor stylistic suggestions #19
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Just an FYI I didn't look at anything that was marked "TODO" |
arnau
reviewed
Jul 16, 2018
| Registers started as pure data, and slowly added different bits of metadata. | ||
| The reference implementation has a few bits of metadata (e.g. description, | ||
| Registers started as pure data, but have evolved as different metadata has been added. | ||
| The reference implementation has some metadata (e.g. description, |
There was a problem hiding this comment.
I've taken parts of this one.
arnau
reviewed
Jul 16, 2018
| This RFC aims to keep backwards compatibility by creating a new log | ||
| to encode metadata changes with references to the data log to keep | ||
| coordination with the original data log. | ||
| This RFC proposes a new log to encode metadata changes which has references to the original data log, in order to maintain backwards compatibility. |
arnau
reviewed
Jul 16, 2018
| @@ -180,7 +176,7 @@ a0 = | |||
| ] | |||
| ``` | |||
|
|
|||
| Note a delta is an ordered set ordered by key. | |||
| Note that a delta is a data set ordered by key. | |||
There was a problem hiding this comment.
Let's talk about this one. A "Set" is unordered by definition. An "Ordered Set" is a different data structure with different expectations. When I say "is an ordered set ordered by key" I mean:
- A delta is an "ordered set" (as opposed as "a set")
- The "ordered set" ordering criteria is by the element key.
arnau
reviewed
Jul 16, 2018
arnau
pushed a commit
that referenced
this pull request
Jul 16, 2018
Find the original suggestions in PR #19 Signed-off-by: Arnau Siches <arnau.siches@digital.cabinet-office.gov.uk>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Made some suggestions to style after request from Arnau, which can be adopted or rejected after review
Changes proposed in this pull request
Style-based changes only
Guidance to review
N/A; this is self-contained