Skip to content
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.

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

Language Documentation warnings #2307

Closed
blowmage opened this issue Aug 15, 2018 · 1 comment
Closed

Language Documentation warnings #2307

blowmage opened this issue Aug 15, 2018 · 1 comment
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@blowmage
Copy link
Contributor

We get the following warnings when generating the documentation. All of them look to be due to trying to link to classes that are not documented, don't exist, or using the wrong namspace. For example, the link {Google::Cloud::Language::V1::LanguageService::AnalyzeEntities AnalyzeEntities} is failing because the constant does not exist. This is a method, and in the GAPIC-generated client this is found at Google::Cloud::Language::V1::LanguageServiceClient#analyze_entities. So I would assume this link should be {#analyze_entities}, since this is string to link to a method the same class. Or possibly link to {Google::Cloud::Language::V1::LanguageService::Service::Stub#analyze_entities Service::Stub#analyze_entities }, but that doesn't make much sense in the context of the GAPIC client class. (And because both Service and Service::Stub are undocumented in the GAPIC documentation.)

Here are the warnings:

[warn]: In file `lib/google/cloud/language/v1/language_service_client.rb':34: Cannot resolve link to Google::Cloud::Language::V1::LanguageService::AnalyzeEntities from text:
	...{Google::Cloud::Language::V1::LanguageService::AnalyzeEntities AnalyzeEntities}...
[warn]: In file `lib/google/cloud/language/v1/language_service_client.rb':274: Cannot resolve link to Google::Cloud::Language::V1::LanguageService::AnalyzeEntities from text:
	...{Google::Cloud::Language::V1::LanguageService::AnalyzeEntities AnalyzeEntities}...
[warn]: In file `lib/google/cloud/language/v1beta2/language_service_client.rb':34: Cannot resolve link to Google::Cloud::Language::V1beta2::LanguageService::AnalyzeEntities from text:
	...{Google::Cloud::Language::V1beta2::LanguageService::AnalyzeEntities AnalyzeEntities}...
[warn]: In file `lib/google/cloud/language/v1beta2/language_service_client.rb':275: Cannot resolve link to Google::Cloud::Language::V1beta2::LanguageService::AnalyzeEntities from text:
	...{Google::Cloud::Language::V1beta2::LanguageService::AnalyzeEntities AnalyzeEntities}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':59: Cannot resolve link to AnalyzeSentiment from text:
	...{AnalyzeSentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':1: Cannot resolve link to AnalyzeSentiment from text:
	...{AnalyzeSentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':1: Cannot resolve link to AnalyzeSentiment from text:
	...{AnalyzeSentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':70: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':757: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':59: Cannot resolve link to AnalyzeSentiment from text:
	...{AnalyzeSentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':1: Cannot resolve link to AnalyzeSentiment from text:
	...{AnalyzeSentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':1: Cannot resolve link to AnalyzeSentiment from text:
	...{AnalyzeSentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':70: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':753: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
[warn]: In file `lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb':1: Cannot resolve link to AnalyzeEntitySentiment from text:
	...{AnalyzeEntitySentiment}...
@JustinBeckwith JustinBeckwith added triage me I really want to be triaged. 🚨 This issue needs some love. labels Aug 16, 2018
@dazuma dazuma added the type: docs Improvement to the documentation for an API. label Aug 22, 2018
@JustinBeckwith JustinBeckwith removed triage me I really want to be triaged. 🚨 This issue needs some love. labels Aug 22, 2018
@dazuma dazuma added the type: cleanup An internal cleanup or hygiene concern. label Aug 22, 2018
@JustinBeckwith JustinBeckwith removed type: cleanup An internal cleanup or hygiene concern. labels Dec 2, 2018
@blowmage
Copy link
Contributor Author

blowmage commented Dec 4, 2018

Moving to backlog.

@blowmage blowmage closed this as completed Dec 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants