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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Improve Function Docstrings #4

Open
6 tasks
TheCedarPrince opened this issue Mar 14, 2023 · 0 comments
Open
6 tasks

[FEATURE] Improve Function Docstrings #4

TheCedarPrince opened this issue Mar 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@TheCedarPrince
Copy link
Collaborator

As it stands, although much of the internal functions for this package build upon DBInterface.jl, which has a very clear interface and documentation corpus, there are several problematic functions within this package that are undocumented so far. Below is a list of functions that need to be documented:

  • _dbconnect from src/mysql.jl
  • _dbconnect from src/sqlite.jl
  • DBInterface.connect from src/postgresql.jl
  • DBInterface.prepare from src/postgresql.jl
  • DBInterface.execute from src/postgresql.jl
  • DBConnection and its dispatch within src/DBConnector.jl

Currently the functionality within src/odbc.jl and src/jdbc.jl are still being fleshed out so I am waiting until that is further stabilized.
@TheCedarPrince TheCedarPrince added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TheCedarPrince