Skip to content
This repository has been archived by the owner on Dec 8, 2022. It is now read-only.

Update example in Readme with the updated version #68

Open
bxcodec opened this issue May 7, 2019 · 3 comments
Open

Update example in Readme with the updated version #68

bxcodec opened this issue May 7, 2019 · 3 comments

Comments

@bxcodec
Copy link
Owner

bxcodec commented May 7, 2019

There are a few examples in the documentation that still use the old version, still need a spare time to do this.

@guyfedwards
Copy link

guyfedwards commented Sep 6, 2019

Also should update the example screenshots to import github.com/bxcodec/faker/v3

bxcodec pushed a commit that referenced this issue Feb 25, 2020
It's required because:
- package users can use godoc.org, pkg.go.dev for exploring
the package documentation
- testable examples can be more in sync with actual code

This commit moves examples from the plain markdown to testable
examples. It allows to test examples during test phase and have
them more in sync with actual code. Also the examples can be
shown by documentation servers and in IDEs and make work with
package much more user-friendly as not everyone looks into
README.md at repo's root.

Related to #68
@andrew-werdna
Copy link
Sponsor Contributor

Is there anything more I could do to help out with this? I see y'all have already made some progress with updating the docs. What is left that I could help with?

@bxcodec
Copy link
Owner Author

bxcodec commented Jun 8, 2020

I made this as a living issue, so if you guys found outdated docs, just freely make a PR.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants