Casing of functions - Githubissues

microsoft / DSCEA

DSC Environment Analyzer (DSCEA) is a simple implementation of PowerShell Desired State Configuration that uses the declarative nature of DSC to scan systems in an environment against a defined reference MOF file and generate compliance reports as to whether systems match the desired configuration.

https://microsoft.github.io/DSCEA

Other

197 stars 41 forks source link

Casing of functions #59

Open ChrisLGardner opened 6 years ago

ChrisLGardner commented 6 years ago

I'm wondering if there was a reason you chose the casing for functions as you did? The two obvious "issues" I see are the following:

DSC used instead of Dsc, as seen in PSDesiredStateConfiguration module
Use of a lower case letter for the first word following DSCEA, e.g. Start-DSCEAscan

Both of these diverge from the PowerShell Style Guide and the .Net Framework Capitalization Conventions.

krjhitch commented 6 years ago

I agree, it should be Start-DscEaScan and/or Get-DscEaPowerBiReport (or similar). Will be altering this in the next release

ChrisLGardner commented 6 years ago

I think Start-DscEAScan and Get-DscEAPowerBIReport would be the correct capitalization, both EA and BI are two letter acronyms and conventions suggest they should be capitalized.

Thanks.