-
Notifications
You must be signed in to change notification settings - Fork 117
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
Create godoc-friendly examples #268
Conversation
Also, i'd like to make lint checks more loose in examples, but as failing CI shows, totally disabling them is a bad idea.. |
Looks like vet fails the examples. But I like this setup. |
I'm out for today... Will try something in near future - tomorrow or may be on Wednesday... If you have any ideas how to make linter have softer checks for examples, please let me know... |
aef995e
to
5d5b4a4
Compare
@deitch if you like those |
Yeah, it's nice. |
Okay, and what about that last action item? Should To be frank, for me, generally, it's a bit counter-intuitive, that |
Oh, I missed that. Sure, those numbers are as good as anything else. |
Move tests from the diskfs.go global comment section and update them as they are slightly out of date.
5d5b4a4
to
779cef6
Compare
Done. I just wanted to make sure, those numbers match the description comment above the example. |
Thanks! Good to have you contributing here. |
Yay, updated docs have finally landed! https://pkg.go.dev/github.com/diskfs/go-diskfs@master Pretty! 🎉 |
Move tests from the diskfs.go global comment section and update them as they are slightly out of date.
@deitch while trying to put my examples together I've found out that code snippets from the header comment block are slightly out of date.
I've converted them to the godoc-friendly versions and also left one
FIXME
item, as I'm not sure how it was intended to work here. Please advise how to fill gpt structures to match the comment above that example.