Skip to content

Add usage examples to Go docs#477

Closed
beyang wants to merge 1 commit into
freeCodeCamp:masterfrom
beyang:master
Closed

Add usage examples to Go docs#477
beyang wants to merge 1 commit into
freeCodeCamp:masterfrom
beyang:master

Conversation

@beyang

@beyang beyang commented Sep 3, 2016

Copy link
Copy Markdown

This adds links to usage examples on Sourcegraph for the Go documentation by adding a new HTML filter for the Go documentation.

This is how they look on devdocs:

Variable examples:
image

Constant examples:
image

Function examples:
image

Constructor function and method examples:
image

These link to pages like this on Sourcegraph: https://sourcegraph.com/github.com/golang/go/-/land/GoPackage/bufio/-/NewReader.

Unit tests are included in usages_test.rb.

@Thibaut

Thibaut commented Sep 18, 2016

Copy link
Copy Markdown
Member

None of the links appear to work (404).

@Thibaut

Thibaut commented Oct 2, 2016

Copy link
Copy Markdown
Member

@beyang ping

@beyang

beyang commented Oct 4, 2016

Copy link
Copy Markdown
Author

Hey @Thibaut, really sorry about the delay. We made some changes on the backend that changed some URL structures. We should have new versions up in the next couple of days. I'll close the PR until then and update it when it's ready.

@beyang beyang closed this Oct 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants