Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing and update help for exported functions #1785

Merged
merged 11 commits into from
Nov 25, 2020
Merged

Conversation

fflaten
Copy link
Collaborator

@fflaten fflaten commented Nov 23, 2020

PR Summary

This PR adds and updates help for exported functions.

  • Add missing help:
    • ConvertTo-JUnitReport
    • ConvertTo-NUnitReport
    • ConvertTo-Pester4Result
    • Export-JUnitReport
    • Export-NUnitReport
    • New-PesterContainer
  • Update help for:
    • BeforeEach
    • AfterEach
    • BeforeAll
    • AfterAll
  • Add missing parameter help for:
    • InModuleScope: Parameters and ArgumentList
    • Invoke-Pester: Container (and Run.Container)
    • It: Tag
    • Mock: RemoveParameterType and RemoveParameterValidation
    • Should: ActualValue
  • Updated wiki-links and command-ref to pester.dev in exported functions
  • Replaced .LINK sections with multiple values with multiple .LINK values. Should be one section per reference
  • Add tests for detecting missing help elements
    • Synopsis
    • Example (currently skipped)
    • Parameters (currently skipped)

Fix #1783
Related #1634

PR Checklist

  • PR has meaningful title
  • Summary describes changes
  • PR is ready to be merged
    • If not, use the arrow next to Create Pull Request to mark it as a draft. PR can be marked Ready for review when it's ready.
  • Tests are added/update (if required)
  • Documentation is updated/added (if required)

@fflaten fflaten marked this pull request as ready for review November 23, 2020 22:58
@fflaten
Copy link
Collaborator Author

fflaten commented Nov 24, 2020

Noticed missing parameter help for Container parameter in Invoke-Pester. Will add this later today + try adding a test for parameters to check the state.

@nohwnd nohwnd added this to the 5.1 milestone Nov 24, 2020
@nohwnd
Copy link
Member

nohwnd commented Nov 24, 2020

@fflaten waiting with release for this, as it is a non-functional change that would be nice to have in 5.1. 🙂

@fflaten
Copy link
Collaborator Author

fflaten commented Nov 24, 2020

Ready for review. Some of the text is stolen from your new pester.dev pages, the rest is written now. I might have documented functions and parameters that I've never used too, so be caution with those. Ex. RemoveParameterType and RemoveParameterValidation in Mock.

Copy link
Member

@nohwnd nohwnd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrote one part, hope I did not make it worse.

src/functions/Pester.SessionState.Mock.ps1 Outdated Show resolved Hide resolved
@nohwnd nohwnd merged commit c5f3693 into pester:v5.0 Nov 25, 2020
@fflaten
Copy link
Collaborator Author

fflaten commented Nov 25, 2020

Looks good, thanks

@fflaten fflaten deleted the addhelp branch November 25, 2020 18:02
@fflaten fflaten mentioned this pull request May 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing help for functions
2 participants