Skip to content

Conversation

@amoeba
Copy link
Member

@amoeba amoeba commented Jul 25, 2025

Creates a dedicated area in the docs for the Golang impl, including:

  • Index page
  • Quickstart page
  • Driver Manager page

This PR does not include cookbooks like we have for other impls.

Closes #3198

@amoeba amoeba requested a review from zeroshade July 25, 2025 04:09
@amoeba amoeba requested a review from lidavidm as a code owner July 25, 2025 04:09
@github-actions github-actions bot added this to the ADBC Libraries 20 milestone Jul 25, 2025
applications to use multiple drivers simultaneously, and decouple
themselves from the specific driver.

TODO: Should we say anything special about the Golang driver manager impl here?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping @zeroshade

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's "just" a wrapper around the C++ driver manager

@amoeba
Copy link
Member Author

amoeba commented Jul 25, 2025

Two things these docs aren't doing that the Python docs are doing:

  • The Python docs can link to the Python API docs. For Go, I just link manually go the gopkg docs.
  • The code blocks aren't tested to make sure they work like the Python ones are (with doctest). I didn't find anything off the shelf but maybe there's a good way to test the code in the .rst files.

I still need to at least test the code manually. I'll do that tomorrow.

@lidavidm
Copy link
Member

The Python docs can link to the Python API docs. For Go, I just link manually go the gopkg docs.

You could try to shove the gopkg docs into Intersphinx but there's a circular dependency between go.dev and the docs build in the release process that makes that a bit annoying.

The code blocks aren't tested to make sure they work like the Python ones are (with doctest). I didn't find anything off the shelf but maybe there's a good way to test the code in the .rst files.

You could use go/sphinx recipes and just include relevant snippets via literalinclude

Comment on lines 22 to 23
The driver manager is a package that provides bindings to the ADBC Go
API. It delegates to dynamically-loaded drivers. This allows
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, should this be more like "The driver manager is a package that implements the ADBC Go API by delegating to dynamically-loaded drivers"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New language in 0326872.

applications to use multiple drivers simultaneously, and decouple
themselves from the specific driver.

TODO: Should we say anything special about the Golang driver manager impl here?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's "just" a wrapper around the C++ driver manager

@amoeba
Copy link
Member Author

amoeba commented Jul 25, 2025

Thanks @lidavidm. @zeroshade mentioned out of band of this PR that they might prefer we use the Go pkgsite for this so I'm going to open up a separate PR to try that out too.

amoeba added a commit that referenced this pull request Aug 5, 2025
Improves the existing go pkgsite by adding a README.

This is an alternative to
#3199.
@amoeba
Copy link
Member Author

amoeba commented Aug 5, 2025

Thanks for taking a look at this first pass @lidavidm. I'm closing this PR in favor of #3204 which I just merged.

@amoeba amoeba closed this Aug 5, 2025
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.

Create high level documentation for Golang implentation

2 participants