Editorial change from 'recorded' flag to 'sampled' flag. #301
Conversation
danielkhan
added
the
Editorial
There was a problem hiding this comment.
some changes unrelated to PR broke the spec. I think it's some markdown tool you use.
In text I feel there is now a mix or recorded indicating recording and sampled indicating decision. I tried to review where it make sense to keep and where to replace to sampled. I'd advice to re-read again to make sure nothing got left out
spec/20-http_header_format.md
Outdated
|
|
||
| When set, the least significant bit documents that the caller may have recorded | ||
| When set, the least significant bit documents that the caller may have sampled |
There was a problem hiding this comment.
one problem with sampled - people not closely familiar with the subject have trouble interpreting "sampled = sampled in" or "sampled = sampled out". Recorded didn't have this problem. Perhaps we can keep the word "recorded" here or specify that sampled means recorded.
spec/20-http_header_format.md
Outdated
| subset of requests. | ||
| 2. Component may also fall back to probability sampling to set flag | ||
| `recorded` to `1` for the subset of requests. | ||
| 1. Component that makes deferred or delayed recording decision may |
There was a problem hiding this comment.
you broke the sublist. Please make sure to validate your changes using Editing the spec instructions:
spec/20-http_header_format.md
Outdated
| @@ -224,24 +224,24 @@ for future use. Implementations MUST set those to zero. | |||
|
|
|||
| ### Examples of HTTP headers | |||
|
|
|||
| *Valid traceparent when caller recorded this request:* | |||
| _Valid traceparent when caller recorded this request:_ | |||
There was a problem hiding this comment.
I'm curious why this change?
spec/20-http_header_format.md
Outdated
| @@ -312,9 +312,10 @@ the `OWS` rule from <a data-cite='!RFC7230#section-3.2.3'>RFC7230 section | |||
|
|
|||
| The `OWS` rule defines an optional whitespace. It is used where zero or more | |||
| whitespace characters might appear. When it is preferred to improve readability | |||
|
|
|||
There was a problem hiding this comment.
this was not intended to be a list =). It is a dash as a punctuation. Please remove newline.
This addresses #265
The 'recorded' wording when not referring to the flag itself was deliberately left untouched.
Another PR will change the paragraph to be more clear and concise.