docs(talent): Fix PersonNameFilter docs by removing a link that was crashing YARD

dazuma · web-flow · commit d3f38fd6f01a · 2020-03-30T21:05:09.000-07:00
diff --git a/google-cloud-talent/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb b/google-cloud-talent/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb
@@ -305,7 +305,7 @@ module ResumeType
         #     so on.)
         # @!attribute [rw] preferred_name
         #   @return [String]
-        #     Preferred name for the person. This field is ignored if {Google::Cloud::Talent::V4beta1::PersonName#structured_name structured_name}
+        #     Preferred name for the person. This field is ignored if `structured_name`
         #     is provided.
         #
         #     Number of characters allowed is 100.
diff --git a/google-cloud-talent/synth.py b/google-cloud-talent/synth.py
@@ -264,5 +264,14 @@
     'http://cldr.unicode.org'
 )
 
+# YARD 0.9.24 crashes when trying to resolve this particular link.
+# Work around it by disabling the link.
+# See https://github.com/googleapis/google-cloud-ruby/issues/5187
+s.replace(
+    'lib/**/profile.rb',
+    '\\{Google::Cloud::Talent::V4beta1::PersonName#structured_name structured_name\\}',
+    '`structured_name`'
+)
+
 # Generate the helper methods
 call(f'bundle update && bundle exec rake generate_partials TALENT_SERVICES={",".join(services)}', shell=True)

Original file line number	Diff line number	Diff line change
`@@ -305,7 +305,7 @@ module ResumeType`
`305`	`305`	`# so on.)`
`306`	`306`	`# @!attribute [rw] preferred_name`
`307`	`307`	`# @return [String]`
`308`		`- # Preferred name for the person. This field is ignored if {Google::Cloud::Talent::V4beta1::PersonName#structured_name structured_name}`
	`308`	+ # Preferred name for the person. This field is ignored if `structured_name`
`309`	`309`	`# is provided.`
`310`	`310`	`#`
`311`	`311`	`# Number of characters allowed is 100.`