Skip to content

Commit 17c219d

Browse files
madpahoej
authored andcommitted
doc: grammar / spelling
Signed-off-by: Paul Horton <[email protected]> - Minor edits based on PR feedback - adding reference to VERS
1 parent 990d66e commit 17c219d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

tea-leaf/tea-leaf.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# The TEA Leaf Object (TLO)
22

3-
_Work in progress_
4-
53
The TEA LEAF is the object that indicates a product version. The API should be
64
very agnostic as to how a "version" is indicated - semver, vers, name, hash or anything else.
75

@@ -20,14 +18,15 @@ a timestamp for a release is required.
2018
- __Product name__: A text field
2119
- __Product version__: A text field, no required syntax
2220
- __Release date__: A unix timestamp
23-
- __Pre-Release__: A boolean flag indicating a pre-release (beta, rc)
21+
- __Pre-release__: A boolean flag indicating a pre-release (beta, rc)
2422
- __Tco_uuid__: A reference to the TEA Collection objet for this release
2523

2624
## Handling the Pre-Release flag
2725

28-
The Pre-Release flag is used to indicate that this is not a final release. For a given Leaf with a UUID, the flag
29-
can be set to indicate a "test", "beta", "alfa" or similar non-deployed release. It can only be set when
30-
creating the LEAF. The TEA implementation may allow it to be unset (False) once. This is to support
26+
The "Pre-release" flag is used to indicate that this is not a final release.
27+
For a given Leaf with a UUID, the flag can be set to indicate a "test", "beta", "alpha"
28+
or similar non-deployed release. It can only be set when creating the LEAF. The TEA implementation
29+
may allow it to be unset (False) once. This is to support
3130
situations where a object is promoted as is after testing to production version. The flag can not
3231
be set after initial creation and publication of the leaf.
3332

@@ -36,4 +35,5 @@ a new leaf with a new UUID and version needs to be created.
3635

3736
## References
3837

39-
- Semantic versioning (Semver): <https://semver.org>
38+
- Semantic versioning (Semver): <https://semver.org>
39+
- PURL VERS <https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst>

0 commit comments

Comments
 (0)