PowerShell-Docs icon indicating copy to clipboard operation
PowerShell-Docs copied to clipboard

Document IArgumentCompleter and ArgumentCompleterAttribute for binary module development

Open rjmholt opened this issue 4 years ago • 1 comments

Argument completers can be defined in .NET DLLs by implementing the IArgumentCompleter interface and using the ArgumentCompleterAttribute on parameters and cmdlets.

There are examples of this in the wild, but there doesn't seem to be any documentation of it beyond API documentation.

We should document how these types can be used not just from PowerShell but from binary modules and give examples. The PowerShell codebase should probably also improve the doc comments on the APIs.

rjmholt avatar Aug 31 '20 22:08 rjmholt

@rjmholt I agree, we should have some docs that provide examples of using this attribute.

Note that the API docs are autogenerated from /// comments in the source code. So any of those doc changes need to be made there.

sdwheeler avatar Sep 15 '20 17:09 sdwheeler