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

Links to library methods not resolved in guides #1370

Closed
quartzmo opened this issue Mar 29, 2017 · 1 comment
Closed

Links to library methods not resolved in guides #1370

quartzmo opened this issue Mar 29, 2017 · 1 comment
Assignees
@quartzmo
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. status: acknowledged type: cleanup An internal cleanup or hygiene concern.

Comments

@quartzmo
Copy link
Member

quartzmo commented Mar 29, 2017 •
edited

I believe this issue is consistent in all of the guides (package landing pages in the gh-pages docs). It is easy to see many examples in the Datastore guide, such as the one shown below. Note that the links to library classes resolve correctly, but not the link to the library method Google::Cloud::Datastore::Dataset#save:

screen shot 2017-03-29 at 11 40 37 am

My hope is that this issue can be resolved in the gcloud-jsondoc branch. Running rake jsondoc in datastore produces the following output:

...
[warn]: In file `lib/google/cloud/datastore.rb':180: Cannot resolve link to Google::Cloud::Datastore::Dataset#save from text:
	{Google::Cloud::Datastore::Dataset#save}...
...
@quartzmo quartzmo added docs status: acknowledged type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Mar 29, 2017
@quartzmo quartzmo self-assigned this Mar 29, 2017
@geigerj geigerj added the priority: p2 Moderately-important priority. Fix may not be included in next release. label 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 Author

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
priority: p2 Moderately-important priority. Fix may not be included in next release. status: acknowledged type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@quartzmo @geigerj