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

Query.types is not documented (correctly) #1727

Closed
redneb opened this issue Sep 20, 2018 · 1 comment
Closed

Query.types is not documented (correctly) #1727

redneb opened this issue Sep 20, 2018 · 1 comment
Milestone

Comments

@redneb
Copy link

redneb commented Sep 20, 2018

This is a minor issue with the documentation and the comments inside the code.

According to the docs, the QueryConfig object (and thus, also the Query constructor) has a member called types, but the docs say nothing about what kind of values it accepts. According to a comment in the code, types must be something like ['int8', 'bool']. But a few lines further down, it is treated like an integer. Based on my testing, this integer appears to be the oid of the type.

So maybe the comment should be removed and possibly add an explanation of the purpose of types in the documentation. A possibly better option would be to change types to accept something like ['int8', 'bool'], but I am not sure if it's worth it.

@charmander charmander added this to the docs milestone Sep 20, 2018
@charmander
Copy link
Collaborator

An example for types no longer appears in the docs.

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

No branches or pull requests

2 participants