Skip to content

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

Merged
merged 3 commits into from
Jun 26, 2025
Merged

Add help for all Durable Functions cmdlets #96

merged 3 commits into from
Jun 26, 2025

Conversation

AnatoliB
Copy link
Collaborator

@AnatoliB AnatoliB commented Jun 25, 2025

Resolves #92

Important note to reviewers:

The following content was auto-generated by platyPS based on the actual module content:

  • the cmdlet names;
  • the SYNTAX sections;
  • the parameter names;
  • the detailed technical information on parameters in the yaml blocks (e.g. type, default value, optional vs. mandatory, pipeline input, etc.);
  • the 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.

@AnatoliB AnatoliB requested a review from Copilot June 25, 2025 17:46
Copy link

@Copilot Copilot AI left a 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

@AnatoliB AnatoliB marked this pull request as ready for review June 25, 2025 17:54
@AnatoliB AnatoliB requested a review from andystaples June 25, 2025 17:54
andystaples
andystaples previously approved these changes Jun 26, 2025
Copy link
Collaborator

@andystaples andystaples left a 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

Copy link
Collaborator

@andystaples andystaples left a comment

Choose a reason for hiding this comment

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

lgtm

@AnatoliB AnatoliB merged commit 1df2c78 into main Jun 26, 2025
2 checks passed
@AnatoliB AnatoliB deleted the anatolib/help branch June 26, 2025 23:50
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.

Add help to every command
3 participants