Fixes for the data provider doc #145
Merged
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
Pull Request Test Coverage Report for Build ad15379abdcf51e6dee1b3d8d379e080f5135cf6-PR-145
💛 - Coveralls |
nciric
approved these changes
Jun 23, 2020
echeran
approved these changes
Jun 25, 2020
| @@ -12,7 +12,7 @@ The following terms are used throughout this document. | |||
| - **Format Version:** A version of the file format, abstracted away from the schema version and data version. For example, Protobuf 2 and Protobuf 3 are format versions. | |||
| - **Format:** How the data is stored on disk or provided from a service. Examples of data formats: JSON, YAML, Memory-Mapped, Protobuf. The format is internal to the data provider. | |||
| - **Hunk:** A small piece of locale data relating to a specific task. For example, the name of January might be a hunk, and a list of all month names could also be considered a hunk. A data piece is expected to reflect a specific type. | |||
| - **LangID:** A tuple of language, script, and region. LangID is a request variable. Subtags should be handled by the ICU4X code rather than the data provider. | |||
| - **LangID:** A tuple of language, script, and region. LangID is a request variable. Unicode Locale Extensions should be handled by the ICU4X code rather than the data provider. | |||
There was a problem hiding this comment.
Just curious, was this change to help be more specific and narrow the scope to more immediately needs?
There was a problem hiding this comment.
I wanted to be more specific that the subtags I was talking about are the Unicode Locale Extensions.
| @@ -160,3 +172,5 @@ The data version is expected to be a well-defined, namespaced identifier for the | |||
| - `FOO_1_1` → Version 1.1 of data from a hypothetical data source named Foo | |||
|
|
|||
| The first data version subtag, or namespace, defines the syntax for the remainder of the identifier. For example, the `CLDR` namespace might accept two or three subtags: major version (`37`), minor version (`alpha1`), and optional patch version (`goog2020a`). | |||
|
|
|||
| *Note:* The syntax for the data version is undefined at this time. What is shown above is merely a strawman example. | |||
There was a problem hiding this comment.
Glad that this was noted as such. FWIW, after I saw this talk on versioning, I started to think differently about semantic versioning (not assuming it to the be standard / best way) and to think about compatibility and versioning of code differently (or at least be more cautious & considerate). But that's just my current perspective.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #10
Fixes #88