Skip to content

Commit

Permalink
Merge branch 'main' into dependabot/cargo/regorus-0.2.8
Browse files Browse the repository at this point in the history
  • Loading branch information
@lquerel
lquerel authored Nov 10, 2024
2 parents d9c2760 + ddd56ea commit a05c716
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 74 deletions.
52 changes: 26 additions & 26 deletions crates/weaver_forge/expected_output/comment_format/example.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@

// DEVICE_ID
// A unique identifier representing the device
//
//
// The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier]. On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here] on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence
//
//
// [vendor identifier]: https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor
// [here]: https://developer.android.com/training/articles/user-data-ids
const DEVICE_ID = ""

// DEVICE_MANUFACTURER
// The name of the device manufacturer
//
//
// The Android OS provides this field via [Build]. iOS apps SHOULD hardcode the value `Apple`
//
//
// [Build]: https://developer.android.com/reference/android/os/Build#MANUFACTURER
const DEVICE_MANUFACTURER = ""

// DEVICE_MODEL_IDENTIFIER
// The model identifier for the device
//
//
// It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device
const DEVICE_MODEL_IDENTIFIER = ""

// DEVICE_MODEL_NAME
// The marketing name for the device model
//
//
// It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative
const DEVICE_MODEL_NAME = ""

Expand All @@ -34,7 +34,7 @@

// DNS_QUESTION_NAME
// The name being queried.
//
//
// If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively
const DNS_QUESTION_NAME = ""

Expand All @@ -43,24 +43,24 @@

// ERROR_TYPE
// Describes a class of error the operation ended with.
//
//
// The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
//
//
// When `error.type` is set to a type (e.g., an exception type), its
// canonical class name identifying the type within the artifact SHOULD be used.
//
//
// Instrumentations SHOULD document the list of errors they report.
//
//
// The cardinality of `error.type` within one instrumentation library SHOULD be low.
// Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
// should be prepared for `error.type` to have high cardinality at query time when no
// additional filters are applied.
//
//
// If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.
//
//
// If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
// it's RECOMMENDED to:
//
//
// - Use a domain-specific attribute
// - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not
const ERROR_TYPE = ""
Expand All @@ -70,11 +70,11 @@

// ATTR
// This is a brief description of the attribute + a short link [OTEL].
//
//
// This is a note about the attribute `attr`. It can be multiline.
//
//
// It can contain a list:
//
//
// - item **1**,
// - lorem ipsum dolor sit amet, consectetur
// adipiscing elit sed do eiusmod tempor
Expand All @@ -83,33 +83,33 @@
// - lorem ipsum dolor sit amet, consectetur
// adipiscing elit sed do eiusmod tempor
// incididunt ut labore et dolore magna aliqua.
//
//
// And an **inline code snippet**: `Attr.attr`.
//
//
// # Summary
//
//
// ## Examples
//
//
// 1. Example 1
// 2. [Example] with lorem ipsum dolor sit amet, consectetur adipiscing elit
// [sed] do eiusmod tempor incididunt ut
// [labore] et dolore magna aliqua.
// 3. Example 3
//
//
// ## Appendix
//
//
// - [Link 1]
// - [Link 2]
// - A very long item in the list with lorem ipsum dolor sit amet, consectetur adipiscing elit sed do eiusmod
// tempor incididunt ut labore et dolore magna aliqua.
//
//
// > This is a blockquote.
// > It can contain multiple lines.
// > Lorem ipsum dolor sit amet, consectetur adipiscing
// > elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
//
//
// > [!NOTE] Something very important here
//
//
// [OTEL]: https://www.opentelemetry.com
// [incididunt]: https://www.loremipsum.com
// [Example]: https://loremipsum.com
Expand Down
2 changes: 1 addition & 1 deletion crates/weaver_forge/expected_output/comment_format/example.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
* It can contain multiple lines.
* Lorem ipsum dolor sit amet, consectetur adipiscing
* elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</blockquote>
*
*
* <p>
* <blockquote>
* [!NOTE] Something very important here</blockquote>
Expand Down
46 changes: 23 additions & 23 deletions crates/weaver_forge/expected_output/comment_format/example.py
View file
Original file line number Diff line number Diff line change
@@ -1,71 +1,71 @@
DEVICE_ID: Final = ""
"""
A unique identifier representing the device
The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence
"""

DEVICE_MANUFACTURER: Final = ""
"""
The name of the device manufacturer
The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`
"""

DEVICE_MODEL_IDENTIFIER: Final = ""
"""
The model identifier for the device
It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device
"""

DEVICE_MODEL_NAME: Final = ""
"""
The marketing name for the device model
It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative
"""

DNS_QUESTION_NAME: Final = ""
"""
The name being queried.
If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \\t, \\r, and \\n respectively
"""

ERROR_TYPE: Final = ""
"""
Describes a class of error the operation ended with.
The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
When `error.type` is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
Instrumentations SHOULD document the list of errors they report.
The cardinality of `error.type` within one instrumentation library SHOULD be low.
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
should be prepared for `error.type` to have high cardinality at query time when no
additional filters are applied.
If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.
If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
it's RECOMMENDED to:
- Use a domain-specific attribute
- Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not
"""

ATTR: Final = ""
"""
This is a brief description of the attribute + a short link [OTEL](https://www.opentelemetry.com).
This is a note about the attribute `attr`. It can be multiline.
It can contain a list:
- item **1**,
- lorem ipsum dolor sit amet, consectetur
adipiscing elit sed do eiusmod tempor
Expand All @@ -74,31 +74,31 @@
- lorem ipsum dolor sit amet, consectetur
adipiscing elit sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
And an **inline code snippet**: `Attr.attr`.
# Summary
## Examples
1. Example 1
2. [Example](https://loremipsum.com) with lorem ipsum dolor sit amet, consectetur adipiscing elit
[sed](https://loremipsum.com) do eiusmod tempor incididunt ut
[labore](https://loremipsum.com) et dolore magna aliqua.
3. Example 3
## Appendix
- [Link 1](https://www.link1.com)
- [Link 2](https://www.link2.com)
- A very long item in the list with lorem ipsum dolor sit amet, consectetur adipiscing elit sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
> This is a blockquote.
> It can contain multiple lines.
> Lorem ipsum dolor sit amet, consectetur adipiscing
> elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
> [!NOTE] Something very important here
"""

46 changes: 23 additions & 23 deletions crates/weaver_forge/expected_output/comment_format/example.rs
View file
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@
//! Examples of comments for group device

/// A unique identifier representing the device
///
///
/// Notes: The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence
const DEVICE_ID: &str = "";

/// The name of the device manufacturer
///
///
/// Notes: The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`
const DEVICE_MANUFACTURER: &str = "";

/// The model identifier for the device
///
///
/// Notes: It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device
const DEVICE_MODEL_IDENTIFIER: &str = "";

/// The marketing name for the device model
///
///
/// Notes: It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative
const DEVICE_MODEL_NAME: &str = "";


//! Examples of comments for group dns

/// The name being queried.
///
///
/// Notes: If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively
const DNS_QUESTION_NAME: &str = "";


//! Examples of comments for group error

/// Describes a class of error the operation ended with.
///
///
/// Notes: The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
///
///
/// When `error.type` is set to a type (e.g., an exception type), its
/// canonical class name identifying the type within the artifact SHOULD be used.
///
///
/// Instrumentations SHOULD document the list of errors they report.
///
///
/// The cardinality of `error.type` within one instrumentation library SHOULD be low.
/// Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
/// should be prepared for `error.type` to have high cardinality at query time when no
/// additional filters are applied.
///
///
/// If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.
///
///
/// If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
/// it's RECOMMENDED to:
///
///
/// - Use a domain-specific attribute
/// - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not
const ERROR_TYPE: &str = "";
Expand All @@ -58,11 +58,11 @@
//! Examples of comments for group other

/// This is a brief description of the attribute + a short link [OTEL](https://www.opentelemetry.com).
///
///
/// Notes: This is a note about the attribute `attr`. It can be multiline.
///
///
/// It can contain a list:
///
///
/// - item **1**,
/// - lorem ipsum dolor sit amet, consectetur
/// adipiscing elit sed do eiusmod tempor
Expand All @@ -71,31 +71,31 @@
/// - lorem ipsum dolor sit amet, consectetur
/// adipiscing elit sed do eiusmod tempor
/// incididunt ut labore et dolore magna aliqua.
///
///
/// And an **inline code snippet**: `Attr.attr`.
///
///
/// # Summary
///
///
/// ## Examples
///
///
/// 1. Example 1
/// 2. [Example](https://loremipsum.com) with lorem ipsum dolor sit amet, consectetur adipiscing elit
/// [sed](https://loremipsum.com) do eiusmod tempor incididunt ut
/// [labore](https://loremipsum.com) et dolore magna aliqua.
/// 3. Example 3
///
///
/// ## Appendix
///
///
/// - [Link 1](https://www.link1.com)
/// - [Link 2](https://www.link2.com)
/// - A very long item in the list with lorem ipsum dolor sit amet, consectetur adipiscing elit sed do eiusmod
/// tempor incididunt ut labore et dolore magna aliqua.
///
///
/// > This is a blockquote.
/// > It can contain multiple lines.
/// > Lorem ipsum dolor sit amet, consectetur adipiscing
/// > elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
///
///
/// > [!NOTE] Something very important here
const ATTR: &str = "";

Expand Down
Loading

0 comments on commit a05c716

Please sign in to comment.