Skip to content

Fix displaying testable example on pkg.go.dev - #587

Merged
goccy merged 1 commit into
goccy:masterfrom
alexandear:fix-testable-examples
Dec 13, 2024
Merged

goccy merged 1 commit into
goccy:masterfrom
alexandear:fix-testable-examples

Conversation

@alexandear

@alexandear alexandear commented Dec 12, 2024 •

Copy link
Copy Markdown
Contributor

Before submitting your PR, please confirm the following.

  • Describe the purpose for which you created this PR.
  • Create test code that corresponds to the modification

The repo contains 11 testable examples, but on the https://pkg.go.dev/github.com/goccy/go-yaml@v1.15.9#pkg-examples there is only 1 example listed. This PR fixes that all examples will be listed after merging.

Before:

image

After:

image

Explanation https://go.dev/blog/examples#example-function-names

@codecov-commenter

codecov-commenter commented Dec 12, 2024 •

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.37%. Comparing base (342293d) to head (3476ea0).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #587   +/-   ##
=======================================
  Coverage   77.37%   77.37%           
=======================================
  Files          21       21           
  Lines        7704     7704           
=======================================
  Hits         5961     5961           
  Misses       1333     1333           
  Partials      410      410           

@goccy goccy left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your great PR!

@goccy
goccy merged commit 7601ad3 into goccy:master Dec 13, 2024
@alexandear
alexandear deleted the fix-testable-examples branch December 13, 2024 10:48
@alexandear

Copy link
Copy Markdown
Contributor Author

Examples can be seen here or here after releasing a new version.

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.

3 participants