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

Clarifying old / reference / frozen terms #613

Open
max-sixty opened this issue Sep 24, 2024 · 0 comments
Open

Clarifying old / reference / frozen terms #613

max-sixty opened this issue Sep 24, 2024 · 0 comments

Comments

@max-sixty
Copy link
Collaborator

This is a bit refine-y, but:

In various parts of the code & docs, we use a bunch of different terms for "snapshot":

  • Snapshot
  • Value
  • Contents

For the "existing snapshot value":

  • Reference value
  • Old snapshot
  • Frozen value

For the "proposed snapshot value":

  • Generated snapshot
  • New snapshot

(I'm sure there are lots more, these just come to mind)

While not doing some big disruptive refactor, I'd propose we gradually coalesce on:

  • "Existing" for the value that's in the repo
  • "Generated" for the value that the code generated
    • Possibly "proposed" once it comes to reviewing the snapshot
  • (and no view on "snapshot" / "value" / "contents")
max-sixty added a commit to max-sixty/insta that referenced this issue Oct 6, 2024
@max-sixty
Standardize names for new/old/reference
4cebba3 
As discussed in mitsuhiko#613.

After doing this, there isn't as much disagreement as I had remembered -- I think we reduced the use of `ReferenceValue` recently as a side-effect of other work. So it's mostly changing names from `old` & `new` to `existing` & `generated`/`proposed`.

Opening the PR but will leave for a few days to consider whether it's worthwhile
@max-sixty max-sixty mentioned this issue Oct 6, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@max-sixty