Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

docs(integrity_checking): improve clarity #695

Closed
wants to merge 2 commits into from
Closed

docs(integrity_checking): improve clarity #695

wants to merge 2 commits into from

Conversation

ca-d
Copy link

@ca-d ca-d commented Jul 13, 2023

I'm making this proposal for improving clarity of the language because I personally found the original phrasing a bit confusing in some places.

@CLAassistant
Copy link

CLAassistant commented Jul 13, 2023

CLA assistant check
All committers have signed the CLA.

I'm making this proposal for improving clarity of the language because I personally found the original phrasing a bit confusing in some places.
@@ -16,16 +16,15 @@ integrity checking and lock files.
Deno can store and check subresource integrity for modules using a small JSON
file. To opt into a lock file, either:

1. Create a `deno.json` file in the current or an ancestor directory, which will
automatically create an additive lockfile at `deno.lock`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the word 'additive lockfile' is intentional and it tries to describe that the contents of it are sum of all dependencies of all relevant files (correct me if I'm wrong cc @dsherret @bartlomieju )

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification, me not understanding this point was actually the chief impulse for this suggestion. If that is the case, I propose to either add an explanation of "additive lockfile" or maybe rename it to "cumulative lockfile", if that more closely reflects the intended meaning.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dsherret What do you think about the above suggestion?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe let's just remove the word "additive" and "additional" here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants