search

codacy / codacy-coverage-reporter-action

GitHub Action for the codacy-coverage-reporter
Other
56 stars 15 forks source link

doc: Rename options to parameters #66

Closed nicklem closed 1 year ago

nicklem commented 1 year ago

When revamping the GitHub action documentation (https://github.com/codacy/codacy-coverage-reporter-action/pull/64), we chose to name the input data "options" to reflect the common naming of data passed to shell scripts.

It turns out that in the context of GitHub actions, the correct name for this data is "parameters", see GitHub documentation.

This PR addresses this by renaming relevant instances of "options" to "parameters" in README.md.

nicklem commented 1 year ago

An interesting read for reference: https://stackoverflow.com/questions/36495669/difference-between-terms-option-argument-and-parameter

It appears that argument is the most generic catchall term.