Skip to content

naming conventions #58

Open
Open
@KonradUdoHannes

Description

@KonradUdoHannes

I think it would be beneficial to change some method names to both increase usability, but also create natural ways of extending the functionality. Please comment on the ideas and provide your own.

helper functions

Currently the helper functions are called .get_all_regions and get_statistics. It might be better to have a uniform naming, i.e. all in both or none of them.

query builder results

Currently there are methods .results and .meta_data in the query builder. I would suggest renaming this to include a verb. Probably .get_results and .get_meta_data, which would make it more apparent that these are methods. Furthermore it would free up the other names to be attributes or properties, which can be used to store results in the query, reprocess fetched results with different formatting etc. By using properties one could even retain the current behavior and have .results fetch results, i.e. call .get_results when it is called for the first time, but then return stored results afterwards.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions