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.

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

add notes and godoc about registering algorithms #13

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thaJeztah
Copy link
Member

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
// )
//
// Even though digests may be assemblable as a string, always verify your input
// with [digest.Parse] or use [digest.Digest.Validate] when accepting untrusted

Choose a reason for hiding this comment

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

I believe referencing another package's godoc is done by using the package full name so in this case it would be something like [github.com/opencontainers/go-digest.Parse]?

At least that's what I understood from this reference

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, that's a good one. I should check.

In case it's useful; you can run the pkg.go.dev docs locally if you install the pkgsite binary; https://github.com/golang/pkgsite

(It's nice to look how the docs look when making such changes!)

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.

None yet

2 participants