Skip to content

Commit 195450b

Browse files
committed
update doc
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
1 parent 4747c97 commit 195450b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

pack.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,10 @@ type PackManifestOptions struct {
103103
// - If packManifestVersion is [PackManifestVersion1_1_RC4]:
104104
// artifactType MUST NOT be empty unless opts.ConfigDescriptor is specified.
105105
// - If packManifestVersion is [PackManifestVersion1_0]:
106-
// when opts.ConfigDescriptor is nil, artifactType will be used as the
107-
// config media type; when opts.ConfigDescriptor is NOT nil,
108-
// artifactType will be ignored.
106+
// if opts.ConfigDescriptor is nil, artifactType will be used as the
107+
// config media type; if artifactType is empty,
108+
// "application/vnd.unknown.config.v1+json" will be used.
109+
// if opts.ConfigDescriptor is NOT nil, artifactType will be ignored.
109110
//
110111
// If succeeded, returns a descriptor of the packed manifest.
111112
func PackManifest(ctx context.Context, pusher content.Pusher, packManifestVersion PackManifestVersion, artifactType string, opts PackManifestOptions) (ocispec.Descriptor, error) {

0 commit comments

Comments
 (0)