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

feat(docfx): add support for examples #2884

Merged
merged 4 commits into from Sep 18, 2020
Merged

feat(docfx): add support for examples #2884

merged 4 commits into from Sep 18, 2020

Commits on Sep 17, 2020

  1. feat(docfx): add support for examples 

    Examples are located in _test.go files, which go/packages parses into a
separate foo_test package. So, this requires an extra step of collecting
all files from the package, including test packages, then parsing them.
That way, the go/doc package can associate types/functions/packages with
the examples for them (rather than an unassociated list).
    @tbpg
    tbpg committed Sep 17, 2020
    Copy the full SHA
    235714a View commit details
    Browse the repository at this point in the history

  2. fix: rename examples field

    @tbpg
    tbpg committed Sep 17, 2020
    Copy the full SHA
    5632951 View commit details
    Browse the repository at this point in the history

  3. Use executable "Play" examples when available

    @tbpg
    tbpg committed Sep 17, 2020
    Copy the full SHA
    01a5af4 View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2020

  1. Merge branch 'master' into example

    @tbpg
    tbpg committed Sep 18, 2020
    Copy the full SHA
    921f8d9 View commit details
    Browse the repository at this point in the history