Skip to content

Commit b005928

Browse files
authored
Fixes #4915 - add info about comments (#4916)
* Fixes #4915 - add info about comments * fix typo
1 parent 02ef61f commit b005928

File tree

7 files changed

+29
-10
lines changed

7 files changed

+29
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Version(s) of documents impacted
2222
- [ ] I have read the [contributors guide](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/CONTRIBUTING.md)
2323
and followed the style and process guidelines
2424
- [ ] PR has a meaningful title
25-
- [ ] PR is targetted at the _staging_ branch
25+
- [ ] PR is targeted at the _staging_ branch
2626
- [ ] All relevant versions updated
2727
- [ ] Includes reference to related issues and PRs - see [Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords).
2828
- [ ] This PR is ready to merge and is not **Work in Progress**

reference/3.0/Microsoft.PowerShell.Utility/ConvertFrom-Json.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
5-
ms.date: 01/14/2019
5+
Module Name: Microsoft.PowerShell.Utility
6+
ms.date: 10/10/2019
67
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertfrom-json?view=powershell-3.0&WT.mc_id=ps-gethelp
78
schema: 2.0.0
89
title: ConvertFrom-Json
910
---
1011
# ConvertFrom-Json
1112

1213
## SYNOPSIS
13-
1414
Converts a JSON-formatted string to a custom object.
1515

1616
## SYNTAX
@@ -31,6 +31,9 @@ To generate a JSON string from any object, use the `ConvertTo-Json` cmdlet.
3131

3232
This cmdlet was introduced in PowerShell 3.0.
3333

34+
> [!NOTE]
35+
> This cmdlet doesn't support JSON with comments.
36+
3437
## EXAMPLES
3538

3639
### Example 1: Convert a DateTime object to a JSON object

reference/4.0/Microsoft.PowerShell.Utility/ConvertFrom-Json.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
5-
ms.date: 01/14/2019
5+
Module Name: Microsoft.PowerShell.Utility
6+
ms.date: 10/10/2019
67
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertfrom-json?view=powershell-4.0&WT.mc_id=ps-gethelp
78
schema: 2.0.0
89
title: ConvertFrom-Json
910
---
1011
# ConvertFrom-Json
1112

1213
## SYNOPSIS
13-
1414
Converts a JSON-formatted string to a custom object.
1515

1616
## SYNTAX
@@ -31,6 +31,9 @@ To generate a JSON string from any object, use the `ConvertTo-Json` cmdlet.
3131

3232
This cmdlet was introduced in PowerShell 3.0.
3333

34+
> [!NOTE]
35+
> This cmdlet doesn't support JSON with comments.
36+
3437
## EXAMPLES
3538

3639
### Example 1: Convert a DateTime object to a JSON object

reference/5.0/Microsoft.PowerShell.Utility/ConvertFrom-Json.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
5-
ms.date: 01/14/2019
5+
Module Name: Microsoft.PowerShell.Utility
6+
ms.date: 10/10/2019
67
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertfrom-json?view=powershell-5.0&WT.mc_id=ps-gethelp
78
schema: 2.0.0
89
title: ConvertFrom-Json
910
---
11+
1012
# ConvertFrom-Json
1113

1214
## SYNOPSIS
@@ -30,6 +32,9 @@ To generate a JSON string from any object, use the `ConvertTo-Json` cmdlet.
3032

3133
This cmdlet was introduced in PowerShell 3.0.
3234

35+
> [!NOTE]
36+
> This cmdlet doesn't support JSON with comments.
37+
3338
## EXAMPLES
3439

3540
### Example 1: Convert a DateTime object to a JSON object

reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-Json.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: Microsoft.PowerShell.Utility
6-
ms.date: 01/14/2019
6+
ms.date: 10/10/2019
77
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertfrom-json?view=powershell-5.1&WT.mc_id=ps-gethelp
88
schema: 2.0.0
99
title: ConvertFrom-Json
@@ -12,7 +12,6 @@ title: ConvertFrom-Json
1212
# ConvertFrom-Json
1313

1414
## SYNOPSIS
15-
1615
Converts a JSON-formatted string to a custom object.
1716

1817
## SYNTAX
@@ -33,6 +32,9 @@ To generate a JSON string from any object, use the `ConvertTo-Json` cmdlet.
3332

3433
This cmdlet was introduced in PowerShell 3.0.
3534

35+
> [!NOTE]
36+
> This cmdlet doesn't support JSON with comments.
37+
3638
## EXAMPLES
3739

3840
### Example 1: Convert a DateTime object to a JSON object

reference/6/Microsoft.PowerShell.Utility/ConvertFrom-Json.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: Microsoft.PowerShell.Utility
6-
ms.date: 03/22/2019
6+
ms.date: 10/10/2019
77
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertfrom-json?view=powershell-6&WT.mc_id=ps-gethelp
88
schema: 2.0.0
99
title: ConvertFrom-Json
@@ -32,6 +32,9 @@ To generate a JSON string from any object, use the `ConvertTo-Json` cmdlet.
3232

3333
This cmdlet was introduced in PowerShell 3.0.
3434

35+
> [!NOTE]
36+
> Beginning with PowerShell 6, this cmdlet supports JSON with comments.
37+
3538
## EXAMPLES
3639

3740
### Example 1: Convert a DateTime object to a JSON object

reference/7/Microsoft.PowerShell.Utility/ConvertFrom-Json.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: Microsoft.PowerShell.Commands.Utility.dll-Help.xml
33
keywords: powershell,cmdlet
44
locale: en-us
55
Module Name: Microsoft.PowerShell.Utility
6-
ms.date: 03/22/2019
6+
ms.date: 10/10/2019
77
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/convertfrom-json?view=powershell-7&WT.mc_id=ps-gethelp
88
schema: 2.0.0
99
title: ConvertFrom-Json
@@ -32,6 +32,9 @@ To generate a JSON string from any object, use the `ConvertTo-Json` cmdlet.
3232

3333
This cmdlet was introduced in PowerShell 3.0.
3434

35+
> [!NOTE]
36+
> Beginning with PowerShell 6, this cmdlet supports JSON with comments.
37+
3538
## EXAMPLES
3639

3740
### Example 1: Convert a DateTime object to a JSON object

0 commit comments

Comments
 (0)