Skip to content

Query.types is not documented (correctly) #1727

Closed
@redneb

Description

@redneb

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions