devblackops / building-powershell-modules-feedback

Feedback on the PowerShell Module Development book
6 stars 1 forks source link

Grammatical error: #7

Closed jbirley closed 4 years ago

jbirley commented 4 years ago

Chapter 6

Section: 6 Choosing a Module Layout (Informational Callout)

States

There could be dozens of functions in a module of this type, and we want to structure the module in the best way that makes it straightforward to develop with, and operates efficiently.

Recommendation

There could be dozens of functions in a module of this type, but we want to structure the module in the best way that makes it straightforward to develop, and operates efficiently.

Section: 6 Choosing a Module Layout

States

One foundational decision that we should make when designing a module is deciding on what file structure the code will be layed out in.

Recommendation

One foundational decision that we should make when designing a module is deciding how its file structure affects the code's layout.

Section: 6.1 Monolithic PSM1 (Code Section)

States

function New-AcmeExmployee {

Recommendation

function New-AcmeEmployee {

Section: 6.1.1 Module structure

States

All PowerShell code in our module will be in this single .psm1 file. Hence the moniker monolithic.

Recommendation

All PowerShell code in our module will be in this single .psm1 file, hence the moniker monolithic.

Section: 6.4 Final verdict

States

The category submodule pattern only partially addresses are concerns, so it isn’t a great option.

Recommendation

The category submodule pattern only partially addresses our concerns, so it isn’t a great option.

Section: 6.4 Final verdict

States

This way, we get the best of both worlds. A good development experience that makes it easy to work on many functions at once, and the fast runtime experience that we get with a monolithic PSM1.

Recommendation

This way, we get the best of both worlds: a good development experience that makes it easy to work on many functions at once, and the fast runtime experience that we get with a monolithic PSM1.

devblackops commented 4 years ago

Fixed. 👍