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

Fix some documentation issues #2768

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion private/bufpkg/bufmodule/commit_key.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ type CommitKey interface {
// DigestType returns the DigestType of the Commit.
//
// Note this is *not* a bufcas.Digest - this is a Digest. bufcas.Digests are a lower-level
// type that just deal in terms of files and content. A Moduleigest is a specific algorithm
// type that just deal in terms of files and content. A ModuleDigest is a specific algorithm
// applied to a set of files and dependencies.
DigestType() DigestType

Expand Down
6 changes: 2 additions & 4 deletions private/bufpkg/bufmodule/module_data.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,13 @@ type ModuleData interface {

// BufYAMLObjectData gets the v1beta1 or v1 buf.yaml ObjectData.
//
// This is always present, even if the Module was created from a v2 buf.yaml file. The BSR will
jchadwick-buf marked this conversation as resolved.
Show resolved Hide resolved
// synthesize a value.
// This is only set if the Module was created from a v1 or v1beta1 buf.yaml file.
//
// This is used for digest calcuations. It is not used otherwise.
V1Beta1OrV1BufYAMLObjectData() (ObjectData, error)
// BufYAMLObjectData gets the v1beta1 or v1 buf.lock ObjectData.
//
// This is always present, even if the Module was created from a v2 buf.yaml file. The BSR will
// synthesize a value.
// This is only set if the Module was created from a v1 or v1beta1 buf.lock file.
//
// This is used for digest calcuations. It is not used otherwise.
V1Beta1OrV1BufLockObjectData() (ObjectData, error)
Expand Down
2 changes: 1 addition & 1 deletion private/bufpkg/bufmodule/module_key.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ type ModuleKey interface {
// Digest returns the Module digest.
//
// Note this is *not* a bufcas.Digest - this is a Digest. bufcas.Digests are a lower-level
// type that just deal in terms of files and content. A Moduleigest is a specific algorithm
// type that just deal in terms of files and content. A ModuleDigest is a specific algorithm
// applied to a set of files and dependencies.
Digest() (Digest, error)

Expand Down
Loading