-
Notifications
You must be signed in to change notification settings - Fork 3
Add help for all Durable Functions cmdlets #96
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces external help documentation for all Durable Functions cmdlets and updates the build process to generate the corresponding MAML files. Key changes include the addition of markdown help files for each cmdlet, minor adjustments to inline documentation in the module file, and an update to build.ps1 for help file generation.
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated no comments.
File | Description |
---|---|
src/Help/*.md | New markdown documentation files for each Durable Functions cmdlet with usage examples and parameter details |
src/AzureFunctions.PowerShell.Durable.SDK.psm1 | Removal of deprecated commented blocks to clean up inline documentation |
build.ps1 | Enhancement to generate external help files with PlatyPS, adding installation and generation steps |
Comments suppressed due to low confidence (2)
src/Help/Suspend-DurableOrchestration.md:2
- Consider standardizing the naming convention for the external help file across all cmdlet help files. For example, align the naming with 'AzureFunctions.PowerShell.Durable.SDK.dll-Help.xml' if that is the intended format.
external help file: AzureFunctions.PowerShell.Durable.SDK-help.xml
src/AzureFunctions.PowerShell.Durable.SDK.psm1:69
- [nitpick] If the commented-out documentation for Start-DurableOrchestration and Send-DurableExternalEvent is no longer relevant, consider removing it entirely to reduce clutter and improve code maintainability.
Invoke-RestMethod -Uri $requestUrl
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a question and a non-blocking clarification request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Resolves #92
Important note to reviewers:
The following content was auto-generated by platyPS based on the actual module content:
SYNTAX
sections;CommonParameters
sections.There is no need to carefully review each and every piece of this data, as platyPS is doing a good job. Just a quick sanity check glance is enough.