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

docs(readme): update programmatic usage example #39

Merged
merged 3 commits into from
Jun 12, 2021
Merged

docs(readme): update programmatic usage example #39

merged 3 commits into from
Jun 12, 2021

Conversation

bastantoine
Copy link
Contributor

@bastantoine bastantoine commented May 27, 2021

Hello! While trying the example in the README, I realized there was an import missing and a wrong usage of two functions. Here's a fix with a working example.

Updated example to fix missing import and wrong usage of functions.
@bastantoine
Copy link
Contributor Author

Hello @princjef ! Any news on this?

@princjef
Copy link
Owner

princjef commented Jun 5, 2021

Hey @bastantoine, sorry for the delay. There was an issue with the build checks that I didn't have a chance to investigate until today.

Thanks for the PR! This repository actually uses its own code to generate its README files. The file you updated is generated from doc.go. Can you make your changes in that file and then run mage doc (or just go run ./cmd/gomarkdoc . if you don't have mage installed) to generate the README changes? Otherwise the changes look good!

@bastantoine
Copy link
Contributor Author

Hello! The files have been updated based on your comments, this should be good now!

@princjef princjef changed the title Updated programmatic usage example in README.md docs(readme): update programmatic usage example Jun 12, 2021
@princjef princjef merged commit da13949 into princjef:master Jun 12, 2021
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.

2 participants