docs(storage): Fix godoc formatting (#14169)

krishnamd-jkp · web-flow · commit 428b228814dc · 2026-03-13T09:57:09.000+05:30
diff --git a/storage/acl.go b/storage/acl.go
@@ -34,8 +34,8 @@ const (
 // They are sometimes referred to as grantees.
 //
 // It could be in the form of:
-// "user-<userId>", "user-<email>", "group-<groupId>", "group-<email>",
-// "domain-<domain>" and "project-team-<projectId>".
+// "user-{userId}", "user-{email}", "group-{groupId}", "group-{email}",
+// "domain-{domain}" and "project-team-{projectId}".
 //
 // Or one of the predefined constants: AllUsers, AllAuthenticatedUsers.
 type ACLEntity string
diff --git a/storage/post_policy_v4.go b/storage/post_policy_v4.go
@@ -40,7 +40,7 @@ type PostPolicyV4Options struct {
 
 	// PrivateKey is the Google service account private key. It is obtainable
 	// from the Google Developers Console.
-	// At https://console.developers.google.com/project/<your-project-id>/apiui/credential,
+	// At https://console.developers.google.com/project/{your-project-id}/apiui/credential,
 	// create a service account client ID or reuse one of your existing service account
 	// credentials. Click on the "Generate new P12 key" to generate and download
 	// a new private key. Once you download the P12 file, use the following command
diff --git a/storage/storage.go b/storage/storage.go
@@ -408,7 +408,7 @@ func (s bucketBoundHostname) path(bucket, object string) string {
 }
 
 // PathStyle is the default style, and will generate a URL of the form
-// "<host-name>/<bucket-name>/<object-name>". By default, <host-name> is
+// "{host-name}/{bucket-name}/{object-name}". By default, {host-name} is
 // storage.googleapis.com, but setting an endpoint on the storage Client or
 // through STORAGE_EMULATOR_HOST overrides this. Setting Hostname on
 // SignedURLOptions or PostPolicyV4Options overrides everything else.
@@ -417,15 +417,15 @@ func PathStyle() URLStyle {
 }
 
 // VirtualHostedStyle generates a URL relative to the bucket's virtual
-// hostname, e.g. "<bucket-name>.storage.googleapis.com/<object-name>".
+// hostname, e.g. "{bucket-name}.storage.googleapis.com/{object-name}".
 func VirtualHostedStyle() URLStyle {
 	return virtualHostedStyle{}
 }
 
 // BucketBoundHostname generates a URL with a custom hostname tied to a
 // specific GCS bucket. The desired hostname should be passed in using the
 // hostname argument. Generated urls will be of the form
-// "<bucket-bound-hostname>/<object-name>". See
+// "{bucket-bound-hostname}/{object-name}". See
 // https://cloud.google.com/storage/docs/request-endpoints#cname and
 // https://cloud.google.com/load-balancing/docs/https/adding-backend-buckets-to-load-balancers
 // for details. Note that for CNAMEs, only HTTP is supported, so Insecure must
@@ -452,7 +452,7 @@ type SignedURLOptions struct {
 
 	// PrivateKey is the Google service account private key. It is obtainable
 	// from the Google Developers Console.
-	// At https://console.developers.google.com/project/<your-project-id>/apiui/credential,
+	// At https://console.developers.google.com/project/{your-project-id}/apiui/credential,
 	// create a service account client ID or reuse one of your existing service account
 	// credentials. Click on the "Generate new P12 key" to generate and download
 	// a new private key. Once you download the P12 file, use the following command
@@ -1550,7 +1550,7 @@ type ObjectAttrs struct {
 
 	// Owner is the owner of the object. This field is read-only.
 	//
-	// If non-zero, it is in the form of "user-<userId>".
+	// If non-zero, it is in the form of "user-{userId}".
 	Owner string
 
 	// Size is the length of the object's content. This field is read-only.
