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

doc: please give the runnable examples in README #621

Open
hitzhangjie opened this issue Aug 30, 2021 · 3 comments
Open

doc: please give the runnable examples in README #621

hitzhangjie opened this issue Aug 30, 2021 · 3 comments

Comments

@hitzhangjie
Copy link

No description provided.

@hitzhangjie hitzhangjie changed the title doc: fix the examples in README, give runnable examples doc: please fix the examples in README to give runnable examples Aug 30, 2021
@hitzhangjie hitzhangjie changed the title doc: please fix the examples in README to give runnable examples doc: please give the runnable examples in README Aug 30, 2021
@atercattus
Copy link
Member

README.md contains examples already 🙂

What do you want exactly? Do you want "play"/" run" button?

@dveeden
Copy link
Collaborator

dveeden commented Mar 11, 2025

I think this is related to #987

We might be able to make more of the examples from the README testable/runnable. However as most depend on a MySQL server/or client a playground isn't very useful.

Then there is https://github.com/go-mysql-org/go-mysql/tree/master/cmd witch servers as runnable examples.

I think we can probably close this. @atercattus @lance6716, what do you think?

@lance6716
Copy link
Collaborator

I think he means the Replication - Example section in README https://github.com/go-mysql-org/go-mysql?tab=readme-ov-file#example can't compile, for example, lacking package line. But we also have a new Examples section now https://github.com/go-mysql-org/go-mysql?tab=readme-ov-file#examples . Maybe we can remove Replication - Example?

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

No branches or pull requests

4 participants