fix(docs): re-order comment to ensure note is included in API docs

hashicorp · Nov 14, 2022 · 98033b8 · 98033b8
1 parent 274e4ab
commit 98033b8
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 1 deletion.
diff --git a/packages/cdktf/lib/tokens/token.ts b/packages/cdktf/lib/tokens/token.ts
@@ -174,10 +174,12 @@ export class Token {
 
   /**
    * Return a Token containing a `null` value
-   * @returns a Token resolving to `null` as understood by Terraform
+   *
    * Note: This is different than `undefined`, `nil`, `None` or similar
    * as it will end up in the Terraform config and can be used to explicitly
    * not set an attribute (which is sometimes required by Terraform providers)
+   *
+   * @returns a Token resolving to `null` as understood by Terraform
    */
   public static nullValue(): IResolvable {
     // passing null works in Typescript, this is why we can do this here

diff --git a/website/docs/cdktf/api-reference/csharp.mdx b/website/docs/cdktf/api-reference/csharp.mdx
@@ -28440,6 +28440,10 @@ Token.NullValue();
 
 Return a Token containing a `null` value.
 
+Note: This is different than `undefined`, `nil`, `None` or similar
+as it will end up in the Terraform config and can be used to explicitly
+not set an attribute (which is sometimes required by Terraform providers)
+
 #### Constants <a name="Constants" id="Constants"></a>
 
 | **Name**                                                                                    | **Type**            | **Description**                        |

diff --git a/website/docs/cdktf/api-reference/go.mdx b/website/docs/cdktf/api-reference/go.mdx
@@ -28440,6 +28440,10 @@ cdktf.Token_NullValue() IResolvable
 
 Return a Token containing a `null` value.
 
+Note: This is different than `undefined`, `nil`, `None` or similar
+as it will end up in the Terraform config and can be used to explicitly
+not set an attribute (which is sometimes required by Terraform providers)
+
 #### Constants <a name="Constants" id="Constants"></a>
 
 | **Name**                                                                                    | **Type**              | **Description**                        |

diff --git a/website/docs/cdktf/api-reference/java.mdx b/website/docs/cdktf/api-reference/java.mdx
@@ -32639,6 +32639,10 @@ Token.nullValue()
 
 Return a Token containing a `null` value.
 
+Note: This is different than `undefined`, `nil`, `None` or similar
+as it will end up in the Terraform config and can be used to explicitly
+not set an attribute (which is sometimes required by Terraform providers)
+
 #### Constants <a name="Constants" id="Constants"></a>
 
 | **Name**                                                                                       | **Type**                      | **Description**                        |

diff --git a/website/docs/cdktf/api-reference/python.mdx b/website/docs/cdktf/api-reference/python.mdx
@@ -34143,6 +34143,10 @@ cdktf.Token.null_value()
 
 Return a Token containing a `null` value.
 
+Note: This is different than `undefined`, `nil`, `None` or similar
+as it will end up in the Terraform config and can be used to explicitly
+not set an attribute (which is sometimes required by Terraform providers)
+
 #### Constants <a name="Constants" id="Constants"></a>
 
 | **Name**                                                                                       | **Type**                              | **Description**                        |

diff --git a/website/docs/cdktf/api-reference/typescript.mdx b/website/docs/cdktf/api-reference/typescript.mdx
@@ -27855,6 +27855,10 @@ Token.nullValue();
 
 Return a Token containing a `null` value.
 
+Note: This is different than `undefined`, `nil`, `None` or similar
+as it will end up in the Terraform config and can be used to explicitly
+not set an attribute (which is sometimes required by Terraform providers)
+
 #### Constants <a name="Constants" id="Constants"></a>
 
 | **Name**                                                                                       | **Type**            | **Description**                        |