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.

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

Jump to bottom

Vision Documentation warnings #2328

Closed
blowmage opened this issue Aug 21, 2018 · 2 comments
Closed

Vision Documentation warnings #2328

blowmage opened this issue Aug 21, 2018 · 2 comments
Assignees
@blowmage
Labels
type: docs Improvement to the documentation for an API.

Comments

@blowmage
Copy link
Contributor

We get the following warnings when generating the documentation. Most of the warnings are "Undocumentable constant" for

A minor amount of errors are from not hiding OperationsClient (ala #2311), and links to protobuf Operations entities that are represented as methods in Ruby, not constants.

Here are the warnings:

[warn]: The proxy Google::Cloud::Vision::V1::ImageAnnotatorClient::OperationsClient.self has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/image_annotator_client.rb'

[warn]: The proxy Google::Cloud::Vision::V1::ImageAnnotatorClient::OperationsClient.self has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/image_annotator_client.rb'

[warn]: The proxy Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.TextAnnotation").msgclass has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/text_annotation_pb.rb'

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Page
	in file 'lib/google/cloud/vision/v1/text_annotation_pb.rb':84:

	84: Page = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Page").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Block
	in file 'lib/google/cloud/vision/v1/text_annotation_pb.rb':85:

	85: Block = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Block").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Paragraph
	in file 'lib/google/cloud/vision/v1/text_annotation_pb.rb':87:

	87: Paragraph = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Paragraph").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Word
	in file 'lib/google/cloud/vision/v1/text_annotation_pb.rb':88:

	88: Word = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Word").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Symbol
	in file 'lib/google/cloud/vision/v1/text_annotation_pb.rb':89:

	89: Symbol = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Symbol").msgclass

[warn]: The proxy Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Feature").msgclass has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/image_annotator_pb.rb'

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::ImageSource
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':251:

	251: ImageSource = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageSource").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Image
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':252:

	252: Image = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Image").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::FaceAnnotation
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':253:

	253: FaceAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.FaceAnnotation").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::LocationInfo
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':256:

	256: LocationInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.LocationInfo").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::Property
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':257:

	257: Property = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Property").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::EntityAnnotation
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':258:

	258: EntityAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.EntityAnnotation").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::SafeSearchAnnotation
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':259:

	259: SafeSearchAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.SafeSearchAnnotation").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::LatLongRect
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':260:

	260: LatLongRect = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.LatLongRect").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::ColorInfo
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':261:

	261: ColorInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ColorInfo").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::DominantColorsAnnotation
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':262:

	262: DominantColorsAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.DominantColorsAnnotation").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::ImageProperties
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':263:

	263: ImageProperties = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageProperties").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::CropHint
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':264:

	264: CropHint = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHint").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::CropHintsAnnotation
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':265:

	265: CropHintsAnnotation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsAnnotation").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::CropHintsParams
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':266:

	266: CropHintsParams = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.CropHintsParams").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::WebDetectionParams
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':267:

	267: WebDetectionParams = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.WebDetectionParams").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::ImageContext
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':268:

	268: ImageContext = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageContext").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AnnotateImageRequest
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':269:

	269: AnnotateImageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateImageRequest").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::ImageAnnotationContext
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':270:

	270: ImageAnnotationContext = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.ImageAnnotationContext").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AnnotateImageResponse
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':271:

	271: AnnotateImageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateImageResponse").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AnnotateFileResponse
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':272:

	272: AnnotateFileResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AnnotateFileResponse").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::BatchAnnotateImagesRequest
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':273:

	273: BatchAnnotateImagesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.BatchAnnotateImagesRequest").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':274:

	274: BatchAnnotateImagesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.BatchAnnotateImagesResponse").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AsyncAnnotateFileRequest
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':275:

	275: AsyncAnnotateFileRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AsyncAnnotateFileRequest").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AsyncAnnotateFileResponse
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':276:

	276: AsyncAnnotateFileResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AsyncAnnotateFileResponse").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':277:

	277: AsyncBatchAnnotateFilesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesResponse
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':278:

	278: AsyncBatchAnnotateFilesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::InputConfig
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':279:

	279: InputConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.InputConfig").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::OutputConfig
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':280:

	280: OutputConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.OutputConfig").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::GcsSource
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':281:

	281: GcsSource = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.GcsSource").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::GcsDestination
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':282:

	282: GcsDestination = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.GcsDestination").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing class Google::Cloud::Vision::V1::OperationMetadata
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':283:

	283: OperationMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.OperationMetadata").msgclass

[warn]: in YARD::Handlers::Ruby::ConstantHandler: Undocumentable constant for existing module Google::Cloud::Vision::V1::Likelihood
	in file 'lib/google/cloud/vision/v1/image_annotator_pb.rb':285:

	285: Likelihood = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.Likelihood").enummodule

[warn]: The proxy Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.vision.v1.WebDetection").msgclass has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/web_detection_pb.rb'

[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':50: Cannot resolve link to Google::Longrunning::Operations::GetOperation from text:
	...{Google::Longrunning::Operations::GetOperation Operations::GetOperation}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':56: Cannot resolve link to Google::Longrunning::Operations::ListOperations from text:
	...{Google::Longrunning::Operations::ListOperations Operations::ListOperations}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':71: Cannot resolve link to Google::Longrunning::Operations::ListOperations from text:
	...{Google::Longrunning::Operations::ListOperations Operations::ListOperations}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':80: Cannot resolve link to Google::Longrunning::Operations::CancelOperation from text:
	...{Google::Longrunning::Operations::CancelOperation Operations::CancelOperation}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':86: Cannot resolve link to Google::Longrunning::Operations::DeleteOperation from text:
	...{Google::Longrunning::Operations::DeleteOperation Operations::DeleteOperation}...
This was referenced Aug 21, 2018
Closed
Merged
Merged
Merged
@JustinBeckwith JustinBeckwith added the triage me I really want to be triaged. label Aug 22, 2018
@dazuma dazuma added the type: docs Improvement to the documentation for an API. label Aug 22, 2018
@JustinBeckwith JustinBeckwith removed the triage me I really want to be triaged. label Aug 22, 2018
@dazuma dazuma added the type: cleanup An internal cleanup or hygiene concern. label Aug 22, 2018
@blowmage
Copy link
Contributor Author

This gem continues to have documentation warnings. Here are the current warnings:

[warn]: The proxy Google::Cloud::Vision::V1::ImageAnnotatorClient::OperationsClient.self has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/image_annotator_client.rb'

[warn]: The proxy Google::Cloud::Vision::V1::ImageAnnotatorClient::OperationsClient.self has not yet been recognized.
If this class/method is part of your source tree, this will affect your documentation results.
You can correct this issue by loading the source file for this object before `lib/google/cloud/vision/v1/image_annotator_client.rb'

[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':51: Cannot resolve link to Google::Longrunning::Operations::GetOperation from text:
	...{Google::Longrunning::Operations::GetOperation Operations::GetOperation}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':57: Cannot resolve link to Google::Longrunning::Operations::ListOperations from text:
	...{Google::Longrunning::Operations::ListOperations Operations::ListOperations}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':72: Cannot resolve link to Google::Longrunning::Operations::ListOperations from text:
	...{Google::Longrunning::Operations::ListOperations Operations::ListOperations}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':81: Cannot resolve link to Google::Longrunning::Operations::CancelOperation from text:
	...{Google::Longrunning::Operations::CancelOperation Operations::CancelOperation}...
[warn]: In file `lib/google/cloud/vision/v1/doc/google/longrunning/operations.rb':87: Cannot resolve link to Google::Longrunning::Operations::DeleteOperation from text:
	...{Google::Longrunning::Operations::DeleteOperation Operations::DeleteOperation}...

@JustinBeckwith JustinBeckwith removed type: cleanup An internal cleanup or hygiene concern. labels Dec 2, 2018
@blowmage
Copy link
Contributor Author

blowmage commented Dec 3, 2018

The latest release of Vision no longer has any documentation warnings.

@blowmage blowmage closed this as completed Dec 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blowmage blowmage

Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@blowmage @dazuma @JustinBeckwith