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

no documentation on v0.16.0 Gen return parameters #30

Open
zephyrtronium opened this issue Sep 5, 2023 · 0 comments · May be fixed by #31
Open

no documentation on v0.16.0 Gen return parameters #30

zephyrtronium opened this issue Sep 5, 2023 · 0 comments · May be fixed by #31

Comments

@zephyrtronium
Copy link

34fab66 added a second string return parameter to Gen functions, but there doesn't appear to be any documentation on the meaning of the new value. I had to read the code to find out that it's the driver name.

A simple fix is to use named return parameters so that the meanings appear in the signature. I will send a PR soon.
zephyrtronium pushed a commit to zephyrtronium/dburl that referenced this issue Sep 5, 2023
add return parameter names to Gen functions
3dd3d38 
34fab66 added a second string return to Gen functions. Use named return
parameters to document the meanings of each.

Notably, GenSqlserver is the only function that actually uses the new
return. Name the second string _ everywhere else to clarify that it can
and should be ignored.

Fixes xo#30.
@zephyrtronium zephyrtronium linked a pull request Sep 5, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add return parameter names to Gen functions zephyrtronium/dburl
1 participant
@zephyrtronium