docs: clarify more language in the Design section #1671
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
Contributor
emschwartz
commented
Mar 8, 2024
emschwartz
commented
- docs: move details about linked events into Client Requests doc
- docs: clarify language in Consistency doc
- docs: rewrap consistency doc at 100 chars
- docs: flesh out debits and credits section
- docs: mention clients' id() function
- docs: reword user_data section
- docs: remove advanced ID examples
- docs: rewrap at 100 chars
docs/design/data-modeling.md
Outdated
| A time-based identifier (such as ULID or UUIDv7) are recommended for most applications. | ||
| A time-based identifier (such as ULID or UUIDv7) is recommended for most applications. | ||
|
|
||
| TigerBeetle clients include an `id()` function to generate IDs using these recommendations. | ||
|
|
||
| A ULID ("Universally Unique Lexicographically Sortable identifier") consists of: |
There was a problem hiding this comment.
Again, we should make it clear that we are describing our own ID scheme, not any spec.
There was a problem hiding this comment.
TigerBeetle Time-Based IDs? TBTBIDs?
emschwartz
force-pushed
the
docs/design-edits-2
branch
from
6d7e84c
to
5b0a943
Compare
emschwartz
force-pushed
the
docs/design-edits-2
branch
from
5b0a943
to
ecd8a05
Compare
sentientwaffle
previously approved these changes
Mar 18, 2024
batiati
reviewed
Mar 18, 2024
Co-authored-by: Rafael Batiati <rbatiati@gmail.com>
sentientwaffle
approved these changes
Mar 18, 2024
batiati
reviewed
Mar 18, 2024
| before the transfer is either posted or voided, the full amount will be voided. | ||
| A pending transfer may optionally be created with a [timeout](../reference/transfers.md#timeout). If | ||
| the timeout interval passes before the transfer is either posted or voided, the transfer expires and | ||
| the full amount is returned to the original account. |
There was a problem hiding this comment.
full amount is returned to the original account.
I think it's more correct to say "the pending balance is removed" instead.
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.