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

Document IArgumentCompleter and ArgumentCompleterAttribute for binary module development #6577

Open
rjmholt opened this issue Aug 31, 2020 · 1 comment
Labels
area-sdk-docs Area - SDK docs area-sdk-ref Area - SDK .NET API

Comments

@rjmholt
Copy link
Contributor

rjmholt commented Aug 31, 2020

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 rjmholt added the issue-doc-idea Issue - request for new content label Aug 31, 2020
@chasewilson chasewilson added area-sdk-docs Area - SDK docs area-sdk-ref Area - SDK .NET API and removed issue-doc-idea Issue - request for new content labels Aug 31, 2020
@sdwheeler
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-sdk-docs Area - SDK docs area-sdk-ref Area - SDK .NET API
Projects
None yet
Development

No branches or pull requests

3 participants