From cd9d9b5125e787af6f46fdf5023f7da49e3c831e Mon Sep 17 00:00:00 2001 From: Frode Flaten <3436158+fflaten@users.noreply.github.com> Date: Tue, 28 Mar 2023 22:47:40 +0200 Subject: [PATCH] Updated generated docs-notice in command reference (#263) * Prepend generated docs-note in command references * Update text and use info-admonition * Update text based on review * Place version note under own heading --- docs/commands/Add-ShouldOperator.mdx | 8 ++++++-- docs/commands/AfterAll.mdx | 8 ++++++-- docs/commands/AfterEach.mdx | 8 ++++++-- docs/commands/Assert-MockCalled.mdx | 8 ++++++-- docs/commands/Assert-VerifiableMock.mdx | 8 ++++++-- docs/commands/BeforeAll.mdx | 8 ++++++-- docs/commands/BeforeDiscovery.mdx | 8 ++++++-- docs/commands/BeforeEach.mdx | 8 ++++++-- docs/commands/Context.mdx | 8 ++++++-- docs/commands/ConvertTo-JUnitReport.mdx | 8 ++++++-- docs/commands/ConvertTo-NUnitReport.mdx | 8 ++++++-- docs/commands/ConvertTo-Pester4Result.mdx | 8 ++++++-- docs/commands/Describe.mdx | 8 ++++++-- docs/commands/Export-JUnitReport.mdx | 8 ++++++-- docs/commands/Export-NUnitReport.mdx | 8 ++++++-- docs/commands/Get-ShouldOperator.mdx | 8 ++++++-- docs/commands/InModuleScope.mdx | 8 ++++++-- docs/commands/Invoke-Pester.mdx | 8 ++++++-- docs/commands/It.mdx | 8 ++++++-- docs/commands/Mock.mdx | 8 ++++++-- docs/commands/New-Fixture.mdx | 8 ++++++-- docs/commands/New-MockObject.mdx | 8 ++++++-- docs/commands/New-PesterConfiguration.mdx | 8 ++++++-- docs/commands/New-PesterContainer.mdx | 8 ++++++-- docs/commands/Set-ItResult.mdx | 8 ++++++-- docs/commands/Should.mdx | 8 ++++++-- docs/commands/docusaurus.sidebar.js | 2 +- generate-command-reference.ps1 | 10 +++++++++- 28 files changed, 166 insertions(+), 54 deletions(-) diff --git a/docs/commands/Add-ShouldOperator.mdx b/docs/commands/Add-ShouldOperator.mdx index 19056173..4eadb222 100644 --- a/docs/commands/Add-ShouldOperator.mdx +++ b/docs/commands/Add-ShouldOperator.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Register a Should Operator with Pester @@ -160,6 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Add-ShouldOperator](https://pester.dev/docs/commands/Add-ShouldOperator) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/AfterAll.mdx b/docs/commands/AfterAll.mdx index 4ae01a2d..fec35f2f 100644 --- a/docs/commands/AfterAll.mdx +++ b/docs/commands/AfterAll.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Defines a series of steps to perform at the end of the current container, @@ -101,6 +105,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/setup-and-teardown](https://pester.dev/docs/usage/setup-and-teardown) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/AfterEach.mdx b/docs/commands/AfterEach.mdx index 0d65ab66..5e64531a 100644 --- a/docs/commands/AfterEach.mdx +++ b/docs/commands/AfterEach.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Defines a series of steps to perform at the end of every It block within @@ -98,6 +102,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/setup-and-teardown](https://pester.dev/docs/usage/setup-and-teardown) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Assert-MockCalled.mdx b/docs/commands/Assert-MockCalled.mdx index d5b56a46..26b78e97 100644 --- a/docs/commands/Assert-MockCalled.mdx +++ b/docs/commands/Assert-MockCalled.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Checks if a Mocked command has been called a certain number of times @@ -178,6 +182,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Assert-MockCalled](https://pester.dev/docs/commands/Assert-MockCalled) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Assert-VerifiableMock.mdx b/docs/commands/Assert-VerifiableMock.mdx index bbc1f1b6..b49f9a7d 100644 --- a/docs/commands/Assert-VerifiableMock.mdx +++ b/docs/commands/Assert-VerifiableMock.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Checks if all verifiable Mocks has been called at least once. @@ -55,6 +59,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Assert-VerifiableMock](https://pester.dev/docs/commands/Assert-VerifiableMock) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/BeforeAll.mdx b/docs/commands/BeforeAll.mdx index 300c2ccd..89017035 100644 --- a/docs/commands/BeforeAll.mdx +++ b/docs/commands/BeforeAll.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Defines a series of steps to perform at the beginning of the current container, @@ -110,6 +114,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/setup-and-teardown](https://pester.dev/docs/usage/setup-and-teardown) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/BeforeDiscovery.mdx b/docs/commands/BeforeDiscovery.mdx index 176756e1..559cdfa2 100644 --- a/docs/commands/BeforeDiscovery.mdx +++ b/docs/commands/BeforeDiscovery.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Runs setup code that is used during Discovery phase. @@ -88,6 +92,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/data-driven-tests](https://pester.dev/docs/usage/data-driven-tests) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/BeforeEach.mdx b/docs/commands/BeforeEach.mdx index 2d63a275..64c2f7af 100644 --- a/docs/commands/BeforeEach.mdx +++ b/docs/commands/BeforeEach.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Defines a series of steps to perform at the beginning of every It block within @@ -95,6 +99,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/setup-and-teardown](https://pester.dev/docs/usage/setup-and-teardown) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Context.mdx b/docs/commands/Context.mdx index 98c6dac2..b518845a 100644 --- a/docs/commands/Context.mdx +++ b/docs/commands/Context.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Provides logical grouping of It blocks within a single Describe block. @@ -175,6 +179,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/testdrive](https://pester.dev/docs/usage/testdrive) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/ConvertTo-JUnitReport.mdx b/docs/commands/ConvertTo-JUnitReport.mdx index d915d6d0..5ca2ae22 100644 --- a/docs/commands/ConvertTo-JUnitReport.mdx +++ b/docs/commands/ConvertTo-JUnitReport.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Converts a Pester result-object to an JUnit-compatible XML report @@ -112,6 +116,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Invoke-Pester](https://pester.dev/docs/commands/Invoke-Pester) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/ConvertTo-NUnitReport.mdx b/docs/commands/ConvertTo-NUnitReport.mdx index bf7cbeca..17923dcb 100644 --- a/docs/commands/ConvertTo-NUnitReport.mdx +++ b/docs/commands/ConvertTo-NUnitReport.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Converts a Pester result-object to an NUnit 2.5-compatible XML-report @@ -112,6 +116,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Invoke-Pester](https://pester.dev/docs/commands/Invoke-Pester) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/ConvertTo-Pester4Result.mdx b/docs/commands/ConvertTo-Pester4Result.mdx index 25254899..c1ad62c5 100644 --- a/docs/commands/ConvertTo-Pester4Result.mdx +++ b/docs/commands/ConvertTo-Pester4Result.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Converts a Pester 5 result-object to an Pester 4-compatible object @@ -80,6 +84,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Invoke-Pester](https://pester.dev/docs/commands/Invoke-Pester) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Describe.mdx b/docs/commands/Describe.mdx index 5d8933cc..a6318cd4 100644 --- a/docs/commands/Describe.mdx +++ b/docs/commands/Describe.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Creates a logical group of tests. @@ -185,6 +189,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/testdrive](https://pester.dev/docs/usage/testdrive) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Export-JUnitReport.mdx b/docs/commands/Export-JUnitReport.mdx index 09bd7fc1..2e742df4 100644 --- a/docs/commands/Export-JUnitReport.mdx +++ b/docs/commands/Export-JUnitReport.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Exports a Pester result-object to an JUnit-compatible XML-report @@ -99,6 +103,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Invoke-Pester](https://pester.dev/docs/commands/Invoke-Pester) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Export-NUnitReport.mdx b/docs/commands/Export-NUnitReport.mdx index f8fecb5d..b4b7ebb8 100644 --- a/docs/commands/Export-NUnitReport.mdx +++ b/docs/commands/Export-NUnitReport.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Exports a Pester result-object to an NUnit-compatible XML-report @@ -99,6 +103,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Invoke-Pester](https://pester.dev/docs/commands/Invoke-Pester) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Get-ShouldOperator.mdx b/docs/commands/Get-ShouldOperator.mdx index ad16a661..757f0146 100644 --- a/docs/commands/Get-ShouldOperator.mdx +++ b/docs/commands/Get-ShouldOperator.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Display the assertion operators available for use with Should. @@ -88,6 +92,6 @@ standard PowerShell discovery patterns (like `Get-Help Should -Parameter *`). [https://pester.dev/docs/commands/Should](https://pester.dev/docs/commands/Should) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/InModuleScope.mdx b/docs/commands/InModuleScope.mdx index 1a20f10c..faacc88b 100644 --- a/docs/commands/InModuleScope.mdx +++ b/docs/commands/InModuleScope.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Allows you to execute parts of a test script within the @@ -198,6 +202,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/InModuleScope](https://pester.dev/docs/commands/InModuleScope) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Invoke-Pester.mdx b/docs/commands/Invoke-Pester.mdx index 719c7e26..9e13c54d 100644 --- a/docs/commands/Invoke-Pester.mdx +++ b/docs/commands/Invoke-Pester.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Runs Pester tests @@ -647,6 +651,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/quick-start](https://pester.dev/docs/quick-start) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/It.mdx b/docs/commands/It.mdx index 3558b050..29853149 100644 --- a/docs/commands/It.mdx +++ b/docs/commands/It.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Validates the results of a test inside of a Describe block. @@ -259,6 +263,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Set-ItResult](https://pester.dev/docs/commands/Set-ItResult) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Mock.mdx b/docs/commands/Mock.mdx index c9d716e7..a859ad5d 100644 --- a/docs/commands/Mock.mdx +++ b/docs/commands/Mock.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Mocks the behavior of an existing command with an alternate @@ -333,6 +337,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/mocking](https://pester.dev/docs/usage/mocking) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-Fixture.mdx b/docs/commands/New-Fixture.mdx index a6bb07c1..873bd7ac 100644 --- a/docs/commands/New-Fixture.mdx +++ b/docs/commands/New-Fixture.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS This function generates two scripts, one that defines a function @@ -136,6 +140,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Should](https://pester.dev/docs/commands/Should) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-MockObject.mdx b/docs/commands/New-MockObject.mdx index a47e1c49..efa3ae7e 100644 --- a/docs/commands/New-MockObject.mdx +++ b/docs/commands/New-MockObject.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS This function instantiates a .NET object from a type. @@ -188,6 +192,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/mocking](https://pester.dev/docs/usage/mocking) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-PesterConfiguration.mdx b/docs/commands/New-PesterConfiguration.mdx index fb152b25..f88ac790 100644 --- a/docs/commands/New-PesterConfiguration.mdx +++ b/docs/commands/New-PesterConfiguration.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Creates a new PesterConfiguration object for advanced configuration of Invoke-Pester. @@ -262,6 +266,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Invoke-Pester](https://pester.dev/docs/commands/Invoke-Pester) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/New-PesterContainer.mdx b/docs/commands/New-PesterContainer.mdx index eacd74cf..4e2ce3bc 100644 --- a/docs/commands/New-PesterContainer.mdx +++ b/docs/commands/New-PesterContainer.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Generates ContainerInfo-objects used as for Invoke-Pester -Container @@ -146,6 +150,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/usage/data-driven-tests](https://pester.dev/docs/usage/data-driven-tests) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Set-ItResult.mdx b/docs/commands/Set-ItResult.mdx index e1a6daff..097d2a50 100644 --- a/docs/commands/Set-ItResult.mdx +++ b/docs/commands/Set-ItResult.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Set-ItResult is used inside the It block to explicitly set the test result @@ -152,6 +156,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/commands/Set-ItResult](https://pester.dev/docs/commands/Set-ItResult) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/Should.mdx b/docs/commands/Should.mdx index f61aff64..e03783b1 100644 --- a/docs/commands/Should.mdx +++ b/docs/commands/Should.mdx @@ -12,6 +12,10 @@ hide_table_of_contents: false custom_edit_url: null --- +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: + ## SYNOPSIS Should is a keyword that is used to define an assertion inside an It block. @@ -1170,6 +1174,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://pester.dev/docs/assertions](https://pester.dev/docs/assertions) -## EDIT THIS PAGE +## VERSION -This page was auto-generated using the comment based help in Pester 5.4.0. To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information. +*This page was generated using comment-based help in [Pester 5.4.0](https://github.com/pester/pester).* diff --git a/docs/commands/docusaurus.sidebar.js b/docs/commands/docusaurus.sidebar.js index c67cb42e..ec25baf5 100644 --- a/docs/commands/docusaurus.sidebar.js +++ b/docs/commands/docusaurus.sidebar.js @@ -1,7 +1,7 @@ /** * Import this file in your Docusaurus `sidebars.js` file. * - * Auto-generated by Alt3.Docusaurus.Powershell 1.0.32. + * Auto-generated by Alt3.Docusaurus.Powershell 1.0.33. * * Copyright (c) 2019-present, ALT3 B.V. * diff --git a/generate-command-reference.ps1 b/generate-command-reference.ps1 index 274f10aa..aaffa2e6 100644 --- a/generate-command-reference.ps1 +++ b/generate-command-reference.ps1 @@ -89,7 +89,15 @@ $docusaurusOptions = @{ "Help" "Documentation" ) - AppendMarkdown = "## EDIT THIS PAGE`nThis page was auto-generated using the comment based help in Pester $($ModuleList.Pester). To edit the content of this page, change the corresponding help in the [pester/Pester](https://github.com/pester/pester) repository. See our [contribution guide](https://github.com/pester/docs#contributing) for more information." + PrependMarkdown = @" +:::info This page was generated +Contributions are welcome in [Pester-repo](https://github.com/pester/pester). +::: +"@ + AppendMarkdown = @" +## VERSION +*This page was generated using comment-based help in [Pester $($ModuleList.Pester)](https://github.com/pester/pester).* +"@ } # -----------------------------------------------------------------------------