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.

Sign up for GitHub

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

Jump to bottom

Improve terminology #2828

Closed
edolstra opened this issue May 7, 2019 · 5 comments
Closed

Improve terminology #2828

edolstra opened this issue May 7, 2019 · 5 comments
Assignees
@edolstra
Labels
flakes
Milestone
flakes-v3

Comments

@edolstra
Copy link
Member

edolstra commented May 7, 2019

We currently have flakerefs, refs and revs, which is super confusing. The ref/rev terminology is Git's fault so maybe we're stuck with those, but we could rename flakerefs.

Maybe "flake URL"? "flake locator"?
@CSVdB
Copy link
Contributor

CSVdB commented May 10, 2019

We could change the current FlakeRef to FlakeUri and the current FlakeUri to FlakeUriString?
If you approve of those names, I can change this right away.

@CSVdB CSVdB assigned CSVdB and edolstra and unassigned CSVdB May 13, 2019
@grahamc grahamc transferred this issue from another repository May 16, 2019
@grahamc grahamc added the flakes label May 16, 2019
@grahamc grahamc added this to the flakes-v2 milestone May 16, 2019
@edolstra
Copy link
Member Author

edolstra commented May 29, 2019 •
edited

More on terminology: the terms provides and requires are poorly chosen since they're verbs rather than nouns. E.g. it's awkward (and ungrammatical) to talk about the provides of a flake. So we need some other terms:

  • provides -> members / assets / outputs ?
  • requires -> dependencies / deps / inputs ?

@grahamc
Copy link
Member

grahamc commented May 29, 2019

inputs and outputs feel like very natural terms to use here, especially in the context of a pure & functional language.

@CSVdB
Copy link
Contributor

CSVdB commented May 29, 2019

I'm against assets because of its meanings in finance etc., and "dependencies/deps" because they're not all the dependencies. Input/output sounds perfect!

edolstra added a commit that referenced this issue May 29, 2019
@edolstra
Rename requires -> inputs, provides -> outputs
6e97998 
Issue #2828.
@edolstra edolstra mentioned this issue May 29, 2019
Merged
edolstra added a commit that referenced this issue May 31, 2019
@edolstra
Rename requires -> inputs, provides -> outputs
094539e 
Issue #2828.
@edolstra edolstra modified the milestones: flakes-v2, flakes-v3 Jun 3, 2019
@edolstra
Copy link
Member Author

Closing, nothing left to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@edolstra edolstra

Labels
flakes
Projects
None yet
Milestone
flakes-v3
Development

No branches or pull requests
3 participants
@grahamc @edolstra @CSVdB