Skip to content

Commit

Permalink
Cleanup generated comments
Browse files Browse the repository at this point in the history
  • Loading branch information
hatchan committed Jun 28, 2024
1 parent 78a644b commit 77c422b
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 7 deletions.
31 changes: 31 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub struct ExportTraceServiceResponse {
/// In such cases, the `rejected_<signal>` MUST have a value of `0` and
/// the `error_message` MUST be non-empty.
///
/// A `partial_success` message with an empty value (rejected_<signal> = 0 and
/// A `partial_success` message with an empty value (rejected\_<signal> = 0 and
/// `error_message` = "") is equivalent to it not being set/present. Senders
/// SHOULD interpret it the same way as in the full success case.
#[prost(message, optional, tag = "1")]
Expand Down
12 changes: 7 additions & 5 deletions fpx/src/models/otel/opentelemetry.proto.trace.v1.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,12 @@ pub struct Span {
/// attributes is a collection of key/value pairs. Note, global attributes
/// like server name can be set using the resource API. Examples of attributes:
///
/// "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
/// "/http/server_latency": 300
/// "example.com/myattribute": true
/// "example.com/score": 10.239
/// ```text
/// "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
/// "/http/server_latency": 300
/// "example.com/myattribute": true
/// "example.com/score": 10.239
/// ```
///
/// The OpenTelemetry API specification further restricts the allowed value types:
/// <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute>
Expand Down Expand Up @@ -390,7 +392,7 @@ pub mod status {
/// a bit-mask. To extract the bit-field, for example, use an
/// expression like:
///
/// (span.flags & SPAN_FLAGS_TRACE_FLAGS_MASK)
/// (span.flags & SPAN_FLAGS_TRACE_FLAGS_MASK)
///
/// See <https://www.w3.org/TR/trace-context-2/#trace-flags> for the flag definitions.
///
Expand Down
2 changes: 1 addition & 1 deletion xtask/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ schemars = { workspace = true }
fpx = { version = "0.1.0", path = "../fpx" }
serde = { workspace = true }
serde_json = { workspace = true }
tonic-build = { version = "0.11" }
tonic-build = { version = "0.11", features = ["cleanup-markdown"] }

0 comments on commit 77c422b

Please sign in to comment.