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

Full YARD parameter type is not displayed in documentation #1422

Closed
beccasaurus opened this issue Apr 13, 2017 · 3 comments
Closed

Full YARD parameter type is not displayed in documentation #1422

beccasaurus opened this issue Apr 13, 2017 · 3 comments
Assignees
@quartzmo
Labels
gapic priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@beccasaurus
Copy link

I'm trying to successfully call MetricServiceClient#create_time_series and the param table only shows Array as the type.

screen shot 2017-04-13 at 1 00 02 am

The actual type specified in the YARD doc for the param is [Array<Google::Monitoring::V3::TimeSeries>]
metric_service_client.rb#L617

The full type should show in the docs.
@blowmage
Copy link
Contributor

I wonder if the angular app is not properly escaping the value, and it thinks the angle brackets are an html element.

@blowmage
Copy link
Contributor

blowmage commented Apr 13, 2017 •
edited

If you look at the JSON that powers the angular app, you will see that the "create_time_series" method has a "time_series" argument with type of "Array<Google::Monitoring::V3::TimeSeries>".

@geigerj geigerj added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Aug 7, 2017
@quartzmo quartzmo added type: cleanup An internal cleanup or hygiene concern. and removed type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Dec 4, 2017
@quartzmo
Copy link
Member

quartzmo commented Mar 7, 2018

Moved to the public planning wiki due to the delay in implementing the new documentation site.

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

@quartzmo quartzmo

Labels
gapic priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@beccasaurus @blowmage @quartzmo @geigerj