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

Suggestion: Examples are lacking best practices #3

Open
albvar opened this issue Jan 29, 2020 · 2 comments
Open

Suggestion: Examples are lacking best practices #3

albvar opened this issue Jan 29, 2020 · 2 comments

Comments

@albvar
Copy link

albvar commented Jan 29, 2020

The function help examples for the majority of the examples are really hard to follow.
The function help examples should leverage examples that the consumers can easily plug in and visualize the output without having to understand the dependencies from function to function. A good way I like to think of this is as follows. Put yourself in the shoes of someone who has never seen this before, how can they quickly figure out if this module does what they need.

@albvar
Copy link
Author

albvar commented Jan 29, 2020

Also you are using Aliases incorrectly. Example, you have Alias "Load-DataGridView" and "Refresh-DataGridview" aliases are not supposed to be another verb-noun convention for an existing function. Instead they are meant to call commands using shorthand, such as gci -> Get-ChildItem, ogv -> Out-GridView, leverage Get-Alias and you can quickly see how to properly implemented aliases per best practices.

@lazywinadmin
Copy link
Owner

lazywinadmin commented Jan 29, 2020

@albvar Thanks for the feedback! Appreciated. This is a old project of mine as you can see and I learned a lot since. I'll try to update it eventually.

Feel free to submit a PR

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

No branches or pull requests

2 participants