search

braid-org / braid-spec

Working area for Braid extensions to HTTP
https://braid.org
233 stars 16 forks source link

Multi-ID versions used in text before they are explained #129

Closed michielbdejong closed 10 months ago

michielbdejong commented 10 months ago

Although this paragraph about ordering and descendants:

For any two versions A and B that are specified in a Version or Parents header, A cannot be a descendent of B or vice versa. The ordering of versions in the list carries no meaning.

relates to the text before it, it also feels like a pretty stand-alone statement that can be moved around a bit. In particular, you could consider moving it past the next one:

A Version header is also allowed to contain multiple IDs, to describe the version of a merger:

      Version: "dkn7ov2vwg", "v2vwgdkn7o"

However, any single mutation SHOULD create only a single version ID, and mergers themselves need not be announced over the network when created. They only need to be referenced after the fact, in some situations.

The advantage would be that the concept of

any two versions A and B that are specified in a Version [...] header

would be easier to understand after the reader knows that multi-ID versions are allowed.

If you think this would be an improvement then I can PR it, if not then it's also fine to leave it as it is!

toomim commented 10 months ago

Oh, you're right!

I'm also noticing that it should say "any two version IDs" and not "any two versions". I've fixed these issues here: https://github.com/braid-org/braid-spec/commit/9531a9702af0d90dd489050ed8e25f87912a9252

Can you take a look and confirm that I did the right thing?

michielbdejong commented 10 months ago

Lovely! Thanks