multistep: use go doc comment syntax #288
Conversation
Updated the `doc.go` file to adhere to [Go Doc Comment](https://go.dev/doc/comment) syntax. This allows the documentation to render correctly on `pkg.go.dev`. I was reading the `multistep` package documentation when I noticed this. Perhaps there are more packages that need updating but I didn't enumerate them.
lbajolet-hashicorp
left a comment
lbajolet-hashicorp
left a comment
There was a problem hiding this comment.
Hey @sudomateo, good to see you here :)
Thanks for the PR, the change looks good to me! You're right that some other packages might need changes similar to this one, we should probably take a look at this, thanks!
Nice to see you as well. Hope all is well with you! As I build out our Oxide Packer plugin I'll submit pull requests if I see any other areas that need updating. Thank you for the review! |
|
Oh, interesting that Oxide's building a Packer plugin for their platform, colour me intrigued :) Good luck on that endeavour, hope it turns out well! When you have releases ready feel free to onboard the docs on devdot, this will make it more visible! Merging this one now |
2 participants
Updated the
doc.gofile to adhere to Go Doc Comment syntax. This allows the documentation to render correctly onpkg.go.dev.I was reading the
multisteppackage documentation when I noticed this. Perhaps there are more packages that need updating but I didn't enumerate them.Before
After