inpsyde / modularity

A PSR-11 implementation for WordPress Plugins, Themes or Libraries.
https://inpsyde.github.io/modularity/
GNU General Public License v2.0
44 stars 4 forks source link

Clarify parameter meaning in Package class #21

Closed widoz closed 1 year ago

widoz commented 1 year ago

The moduleProgress get passed a Module status as second parameter but the name of the parameter is type while the rest of the class associate the status meaning to it.

More over the modulesStatus dictionary it is holding the module Ids by statuses keys.

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...) Improve communication by giving the correct name to method parameters. It basically renames the $type variable to $status because the parameter is referring to the Module Status.

What is the current behavior? (You can also link to an open issue here) Incorrect naming for Package::moduleProgress parameter

What is the new behavior (if this is a feature change)? Correct naming for Package::moduleProgress parameter

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?) no

Other information: