Skip to content

chore: preview YARD formatting fixes from gapic-generator-ruby #1337 #36512

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.

Sign up for GitHub

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

Closed
suztomo wants to merge 1 commit into from
Closed

chore: preview YARD formatting fixes from gapic-generator-ruby #1337 #36512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions google-apps-chat-v1/lib/google/apps/chat/v1/chat_service/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4165,26 +4165,26 @@ def create_reaction request, options = nil
# For example, the following queries are valid:
#
# ```
# user.name = "users/\\{user}"
# user.name = "users/{user}"
# emoji.unicode = "🙂"
# emoji.custom_emoji.uid = "\\{uid}"
# emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" OR emoji.unicode = "👍"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
# emoji.unicode = "🙂" AND user.name = "users/\\{user}"
# (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}")
# AND user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" AND user.name = "users/{user}"
# (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
# AND user.name = "users/{user}"
# ```
#
# The following queries are invalid:
#
# ```
# emoji.unicode = "🙂" AND emoji.unicode = "👍"
# emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}"
# emoji.unicode = "🙂" OR user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR
# user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
# AND user.name = "users/\\{user}"
# emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" OR user.name = "users/{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
# user.name = "users/{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
# AND user.name = "users/{user}"
# ```
#
# Invalid queries are rejected with an `INVALID_ARGUMENT` error.
Expand Down
24 changes: 12 additions & 12 deletions google-apps-chat-v1/lib/google/apps/chat/v1/chat_service/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4038,26 +4038,26 @@ def create_reaction request, options = nil
# For example, the following queries are valid:
#
# ```
# user.name = "users/\\{user}"
# user.name = "users/{user}"
# emoji.unicode = "🙂"
# emoji.custom_emoji.uid = "\\{uid}"
# emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" OR emoji.unicode = "👍"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
# emoji.unicode = "🙂" AND user.name = "users/\\{user}"
# (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}")
# AND user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" AND user.name = "users/{user}"
# (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
# AND user.name = "users/{user}"
# ```
#
# The following queries are invalid:
#
# ```
# emoji.unicode = "🙂" AND emoji.unicode = "👍"
# emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}"
# emoji.unicode = "🙂" OR user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR
# user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
# AND user.name = "users/\\{user}"
# emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" OR user.name = "users/{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
# user.name = "users/{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
# AND user.name = "users/{user}"
# ```
#
# Invalid queries are rejected with an `INVALID_ARGUMENT` error.
Expand Down
2 changes: 1 addition & 1 deletion google-apps-chat-v1/proto_docs/google/apps/card/v1/card.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1751,7 +1751,7 @@ class Icon
# settings under **Customize**.
# @!attribute [rw] weight
# @return [::Integer]
# The stroke weight of the icon. Choose from {100, 200, 300, 400,
# The stroke weight of the icon. Choose from \\{100, 200, 300, 400,
# 500, 600, 700}. If absent, default value is 400. If any other value is
# specified, the default value is used.
#
Expand Down
2 changes: 1 addition & 1 deletion google-apps-chat-v1/proto_docs/google/chat/v1/annotation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ module V1
# "length":7,
# "userMention": {
# "user": {
# "name":"users/\\{user}",
# "name":"users/{user}",
# "displayName":"FooBot",
# "avatarUrl":"https://goo.gl/aeDtrS",
# "type":"BOT"
Expand Down
24 changes: 12 additions & 12 deletions google-apps-chat-v1/proto_docs/google/chat/v1/reaction.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,26 +176,26 @@ class CreateReactionRequest
# For example, the following queries are valid:
#
# ```
# user.name = "users/\\{user}"
# user.name = "users/{user}"
# emoji.unicode = "🙂"
# emoji.custom_emoji.uid = "\\{uid}"
# emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" OR emoji.unicode = "👍"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
# emoji.unicode = "🙂" AND user.name = "users/\\{user}"
# (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}")
# AND user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" AND user.name = "users/{user}"
# (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
# AND user.name = "users/{user}"
# ```
#
# The following queries are invalid:
#
# ```
# emoji.unicode = "🙂" AND emoji.unicode = "👍"
# emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "\\{uid}"
# emoji.unicode = "🙂" OR user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}" OR
# user.name = "users/\\{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "\\{uid}"
# AND user.name = "users/\\{user}"
# emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
# emoji.unicode = "🙂" OR user.name = "users/{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
# user.name = "users/{user}"
# emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
# AND user.name = "users/{user}"
# ```
#
# Invalid queries are rejected with an `INVALID_ARGUMENT` error.
Expand Down
2 changes: 1 addition & 1 deletion google-apps-chat-v1/proto_docs/google/chat/v1/space.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ class Principal
# Optional. Setting for toggling space history on and off.
# @!attribute [rw] use_at_mention_all
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
# Optional. Setting for using @all in a space.
# Optional. Setting for using `@all` in a space.
# @!attribute [rw] manage_apps
# @return [::Google::Apps::Chat::V1::Space::PermissionSetting]
# Optional. Setting for managing apps in a space.
Expand Down
6 changes: 3 additions & 3 deletions google-apps-chat-v1/proto_docs/google/chat/v1/space_notification_setting.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ module NotificationSetting
# Reserved.
NOTIFICATION_SETTING_UNSPECIFIED = 0

# Notifications are triggered by @mentions, followed threads, first
# Notifications are triggered by `@mentions`, followed threads, first
# message of new threads. All new threads are automatically followed,
# unless manually unfollowed by the user.
ALL = 1

# The notification is triggered by @mentions, followed threads, first
# The notification is triggered by `@mentions`, followed threads, first
# message of new threads. Not available for 1:1 direct messages.
MAIN_CONVERSATIONS = 2

# The notification is triggered by @mentions, followed threads. Not
# The notification is triggered by `@mentions`, followed threads. Not
# available for 1:1 direct messages.
FOR_YOU = 3

Expand Down
4 changes: 2 additions & 2 deletions ...-subscriptions-v1/lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,11 +559,11 @@ def get_subscription request, options = nil
# event_types:"google.workspace.chat.message.v1.created"
#
# event_types:"google.workspace.chat.message.v1.created" AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
#
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
# event_types:"google.workspace.chat.message.v1.created" ) AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
# ```
#
# The server rejects invalid queries with an `INVALID_ARGUMENT`
Expand Down
4 changes: 2 additions & 2 deletions ...criptions-v1/lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,11 +539,11 @@ def get_subscription request, options = nil
# event_types:"google.workspace.chat.message.v1.created"
#
# event_types:"google.workspace.chat.message.v1.created" AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
#
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
# event_types:"google.workspace.chat.message.v1.created" ) AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
# ```
#
# The server rejects invalid queries with an `INVALID_ARGUMENT`
Expand Down
4 changes: 2 additions & 2 deletions ...-subscriptions-v1/proto_docs/google/apps/events/subscriptions/v1/subscriptions_service.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,11 @@ class ReactivateSubscriptionRequest
# event_types:"google.workspace.chat.message.v1.created"
#
# event_types:"google.workspace.chat.message.v1.created" AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
#
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
# event_types:"google.workspace.chat.message.v1.created" ) AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
# ```
#
# The server rejects invalid queries with an `INVALID_ARGUMENT`
Expand Down
4 changes: 2 additions & 2 deletions ...ptions-v1beta/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,11 +559,11 @@ def get_subscription request, options = nil
# event_types:"google.workspace.chat.message.v1.created"
#
# event_types:"google.workspace.chat.message.v1.created" AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
#
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
# event_types:"google.workspace.chat.message.v1.created" ) AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
# ```
#
# The server rejects invalid queries with an `INVALID_ARGUMENT`
Expand Down
4 changes: 2 additions & 2 deletions ...s-v1beta/lib/google/apps/events/subscriptions/v1beta/subscriptions_service/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,11 +539,11 @@ def get_subscription request, options = nil
# event_types:"google.workspace.chat.message.v1.created"
#
# event_types:"google.workspace.chat.message.v1.created" AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
#
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
# event_types:"google.workspace.chat.message.v1.created" ) AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
# ```
#
# The server rejects invalid queries with an `INVALID_ARGUMENT`
Expand Down
4 changes: 2 additions & 2 deletions ...ptions-v1beta/proto_docs/google/apps/events/subscriptions/v1beta/subscriptions_service.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,11 @@ class ReactivateSubscriptionRequest
# event_types:"google.workspace.chat.message.v1.created"
#
# event_types:"google.workspace.chat.message.v1.created" AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
#
# ( event_types:"google.workspace.chat.membership.v1.updated" OR
# event_types:"google.workspace.chat.message.v1.created" ) AND
# target_resource="//chat.googleapis.com/spaces/\\{space}"
# target_resource="//chat.googleapis.com/spaces/{space}"
# ```
#
# The server rejects invalid queries with an `INVALID_ARGUMENT`
Expand Down
2 changes: 1 addition & 1 deletion google-apps-meet-v2/proto_docs/google/apps/meet/v2/resource.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ module State
# @return [::String]
# Output only. The `fileId` for the underlying MP4 file. For example,
# "1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP". Use `$ GET
# https://www.googleapis.com/drive/v3/files/\\{$fileId}?alt=media` to download
# https://www.googleapis.com/drive/v3/files/{$fileId}?alt=media` to download
# the blob. For more information, see
# https://developers.google.com/drive/api/v3/reference/files/get.
# @!attribute [r] export_uri
Expand Down
2 changes: 1 addition & 1 deletion google-apps-meet-v2beta/proto_docs/google/apps/meet/v2beta/resource.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ module State
# @return [::String]
# Output only. The `fileId` for the underlying MP4 file. For example,
# "1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP". Use `$ GET
# https://www.googleapis.com/drive/v3/files/\\{$fileId}?alt=media` to download
# https://www.googleapis.com/drive/v3/files/{$fileId}?alt=media` to download
# the blob. For more information, see
# https://developers.google.com/drive/api/v3/reference/files/get.
# @!attribute [r] export_uri
Expand Down
4 changes: 2 additions & 2 deletions google-cloud-agent_registry-v1/proto_docs/google/cloud/agentregistry/v1/agent.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ module V1
# Output only. Attributes of the Agent.
# Valid values:
#
# * `agentregistry.googleapis.com/system/Framework`: {"framework":
# * `agentregistry.googleapis.com/system/Framework`: \\{"framework":
# "google-adk"} - the agent framework used to develop the Agent. Example
# values: "google-adk", "langchain", "custom".
# * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal":
# * `agentregistry.googleapis.com/system/RuntimeIdentity`: \\{"principal":
# "principal://..."} - the runtime identity associated with the Agent.
# * `agentregistry.googleapis.com/system/RuntimeReference`: \\{"uri": "//..."}
# - the URI of the underlying resource hosting the Agent, for
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-agent_registry-v1/proto_docs/google/cloud/agentregistry/v1/mcp_server.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ module V1
# Output only. Attributes of the MCP Server.
# Valid values:
#
# * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal":
# * `agentregistry.googleapis.com/system/RuntimeIdentity`: \\{"principal":
# "principal://..."} - the runtime identity associated with the MCP Server.
# * `agentregistry.googleapis.com/system/RuntimeReference`: \\{"uri": "//..."}
# - the URI of the underlying resource hosting the MCP Server, for
Expand Down
2 changes: 1 addition & 1 deletion ...platform-v1/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ def streaming_read_feature_values request, options = nil
# Required. The resource name of the EntityType for the entities being
# written. Value format:
# `projects/{project}/locations/{location}/featurestores/
# \\{featurestore}/entityTypes/\\{entityType}`. For example,
# {featurestore}/entityTypes/{entityType}`. For example,
# for a machine learning model predicting user clicks on a website, an
# EntityType ID could be `user`.
# @param payloads [::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload, ::Hash>]
Expand Down
2 changes: 1 addition & 1 deletion ...orm-v1/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ def streaming_read_feature_values request, options = nil
# Required. The resource name of the EntityType for the entities being
# written. Value format:
# `projects/{project}/locations/{location}/featurestores/
# \\{featurestore}/entityTypes/\\{entityType}`. For example,
# {featurestore}/entityTypes/{entityType}`. For example,
# for a machine learning model predicting user clicks on a website, an
# EntityType ID could be `user`.
# @param payloads [::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload, ::Hash>]
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-ai_platform-v1/proto_docs/google/cloud/aiplatform/v1/evaluation_service.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ class PredefinedMetricSpec
# Required. The type of the computation based metric.
# @!attribute [rw] parameters
# @return [::Google::Protobuf::Struct]
# Optional. A map of parameters for the metric, e.g. {"rouge_type":
# Optional. A map of parameters for the metric, e.g. \\{"rouge_type":
# "rougeL"}.
class ComputationBasedMetricSpec
include ::Google::Protobuf::MessageExts
Expand Down
2 changes: 1 addition & 1 deletion ...cloud-ai_platform-v1/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module V1
# Required. The resource name of the EntityType for the entities being
# written. Value format:
# `projects/{project}/locations/{location}/featurestores/
# \\{featurestore}/entityTypes/\\{entityType}`. For example,
# {featurestore}/entityTypes/{entityType}`. For example,
# for a machine learning model predicting user clicks on a website, an
# EntityType ID could be `user`.
# @!attribute [rw] payloads
Expand Down
Loading
Loading