Fix some documentation issues #2768
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bufdev
reviewed
Feb 14, 2024
|
OK, adjusted a bit. While v1 buf.yaml data should always be present in current cases, v1 buf.lock data definitely can't always be present, otherwise it would make the b4 digest incompatible for modules that were pushed without a buf.lock file. So, I think that part of the contract really is wrong. |
|
Typos have been fixed, we can revisit this when we figure out what we want to do |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moduleigest->ModuleDigestV1Beta1OrV1BufYAMLObjectDataandV1Beta1OrV1BufLockObjectDataare seemingly relied on to returnnilin case of v2 modules right now, so this doc comment seems wrong.calcuations-> `calculations