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: Support godoc examples for 'simple' and 'advanced' configurations, add GoDoc badge #247

Merged

Conversation

dxh9845
Copy link

@dxh9845 dxh9845 commented Jul 11, 2024

This PR adds Godoc examples on how to use the Goduckdb driver. These examples will be rendered inline on the DuckDB GoDoc page.

Here's how the examples look when rendered locally:
image

I've also added the GoDoc badge that will link directly to the documentation.

Please let me know if this is ok!

@marcboeker
Copy link
Owner

@dxh9845 Thanks for your contribution. More examples is always a good idea. Do you think we can move them to the examples/ folder and convert the existing examples also to the specific Godoc format to have a common place and format for all examples?

@dxh9845
Copy link
Author

dxh9845 commented Jul 25, 2024

@marcboeker Up to you - although in this case, the examples will show up on the Go doc page at the root package, whereas if it was in the examples directory, they'd appear only on the godoc page for the examples package. Let me know which you prefer.

@taniabogatsch
Copy link
Collaborator

We can link to the godoc examples package in the DuckDB docs, and in the README.md. Then, we can add many different examples to the folder, and don't have to worry about cluttering the source folder with files.

Would that work @dxh9845?

@taniabogatsch taniabogatsch added the documentation Requires documentation or contains documentation changes label Sep 5, 2024
@taniabogatsch taniabogatsch merged commit 1a1dfe4 into marcboeker:main Oct 9, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Requires documentation or contains documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants