Skip to content

Comment help snippet should optionally allow placement inside of function definition #763

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

Closed
daviwil opened this issue May 18, 2017 · 3 comments
Assignees
Labels
Area-Snippets Issue-Enhancement A feature request (enhancement).
Milestone

Comments

@daviwil
Copy link
Contributor

daviwil commented May 18, 2017

It seems there are a number of people requesting the ability for our new comment help snippet to place the help string inside of the function body. We should enable this to work there based on where the user is typing (above function, inside of function above param block, or bottom of function). Better to be smart about it and place it where the user is typing than making them set an option.

@daviwil daviwil added Area-General Issue-Enhancement A feature request (enhancement). labels May 18, 2017
@daviwil daviwil added this to the 1.2.0 milestone May 18, 2017
@pcgeek86
Copy link
Contributor

You beat me to filing this bug. :)

@rkeithhill
Copy link
Contributor

rkeithhill commented May 18, 2017

Choice is good. :-) Also, 👍 on making this dependent on where the user is typing instead of adding another setting.

@daviwil
Copy link
Contributor Author

daviwil commented May 18, 2017

PSScriptAnalyzer can already do it, we've just got to wire it up :)

https://github.com/PowerShell/PSScriptAnalyzer/blob/development/RuleDocumentation/ProvideCommentHelp.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Snippets Issue-Enhancement A feature request (enhancement).
Projects
None yet
Development

No branches or pull requests

4 participants