*
* [!NOTE] Something very important herediff --git a/crates/weaver_forge/expected_output/comment_format/example.py b/crates/weaver_forge/expected_output/comment_format/example.py index cd4677bf..dc4e1e60 100644 --- a/crates/weaver_forge/expected_output/comment_format/example.py +++ b/crates/weaver_forge/expected_output/comment_format/example.py @@ -1,59 +1,59 @@ 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 """ @@ -61,11 +61,11 @@ 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 @@ -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 """ diff --git a/crates/weaver_forge/expected_output/comment_format/example.rs b/crates/weaver_forge/expected_output/comment_format/example.rs index a2b38245..a666e46e 100644 --- a/crates/weaver_forge/expected_output/comment_format/example.rs +++ b/crates/weaver_forge/expected_output/comment_format/example.rs @@ -1,22 +1,22 @@ //! 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 = ""; @@ -24,7 +24,7 @@ //! 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 = ""; @@ -32,24 +32,24 @@ //! 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 = ""; @@ -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 @@ -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 = ""; diff --git a/crates/weaver_forge/src/extensions/code.rs b/crates/weaver_forge/src/extensions/code.rs index 8b6fdbe0..7cf4cb92 100644 --- a/crates/weaver_forge/src/extensions/code.rs +++ b/crates/weaver_forge/src/extensions/code.rs @@ -181,9 +181,16 @@ pub(crate) fn comment( if !new_comment.is_empty() { new_comment.push('\n'); } + // We apply "trim" to all split lines. if header.is_empty() && new_comment.is_empty() { // For the first line we don't add the indentation - new_comment.push_str(&format!("{}{}", prefix, line)); + if comment_format.trim { + new_comment.push_str(format!("{}{}", prefix, line).trim_end()); + } else { + new_comment.push_str(&format!("{}{}", prefix, line)); + } + } else if comment_format.trim { + new_comment.push_str(format!("{}{}{}", indent, prefix, line).trim_end()); } else { new_comment.push_str(&format!("{}{}{}", indent, prefix, line)); }