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

improve dependency terminology #84

Open
grahamdyson opened this issue Oct 31, 2019 · 0 comments
Open

improve dependency terminology #84

grahamdyson opened this issue Oct 31, 2019 · 0 comments

Comments

@grahamdyson
Copy link
Member

Eunice currently uses the term "depends upon". The intention of using this terminology was to avoid ambiguity in what direction the dependency being defined has. This terminology is used in YAML.

- id: item 1
  dependsUpon: item 2
- item 2

I think this can be simplified and made easier to remember.

  • The word "upon" is unnecessarily formal and doesn't add more meaning than just "on".
  • "depends upon" or even "depends on" is difficult to differentiate between singular and multiple.
  • It is not possible in Eunice YAML to represent dependencies in the other direction.
  • There is a convention in software to describe dependencies in this direction just as "dependencies". In other projects (e.g. NPM) dependencies in the other direction are defined as being "dependents".

In YAML "dependsUpon" could be replaced with just "dependencies".

@grahamdyson grahamdyson modified the milestone: backlog Jul 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant