improve doc

Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
oras-project · Aug 1, 2023 · f536a32 · f536a32
1 parent c173ce6
commit f536a32
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/registry/remote/warning.go b/registry/remote/warning.go
@@ -58,6 +58,10 @@ type WarningValue struct {
 
 // Warning contains the value of the warning header and other information
 // related to the warning.
+//
+// References:
+//   - https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc3/spec.md#warnings
+//   - https://www.rfc-editor.org/rfc/rfc7234#section-5.5
 type Warning struct {
 	// Value is the value of the warning header.
 	Value WarningValue