- 
                Notifications
    
You must be signed in to change notification settings  - Fork 161
 
docs: create dedicated docs for Golang impl #3199
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
Conversation
        
          
                docs/source/go/driver_manager.rst
              
                Outdated
          
        
      | 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? | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ping @zeroshade
There was a problem hiding this comment.
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
| 
           Two things these docs aren't doing that the Python docs are doing: 
 I still need to at least test the code manually. I'll do that tomorrow.  | 
    
          
 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. 
 You could use go/sphinx recipes and just include relevant snippets via literalinclude  | 
    
        
          
                docs/source/go/driver_manager.rst
              
                Outdated
          
        
      | The driver manager is a package that provides bindings to the ADBC Go | ||
| API. It delegates to dynamically-loaded drivers. This allows | 
There was a problem hiding this comment.
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"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New language in 0326872.
        
          
                docs/source/go/driver_manager.rst
              
                Outdated
          
        
      | 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? | 
There was a problem hiding this comment.
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
| 
           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.  | 
    
Improves the existing go pkgsite by adding a README. This is an alternative to #3199.
Creates a dedicated area in the docs for the Golang impl, including:
This PR does not include cookbooks like we have for other impls.
Closes #3198