Skip to content

[Feature] Print supported filter types to users #48

Open

Description

@OmarMuhammedAli

Is your feature request related to a problem? Please describe.
A user may enter an unsupported filter when querying the SDK. Instead of just throwing an error, a list of supported filters should be logged to the user.

Describe the solution you'd like
A function that raises an exception in case of a wrong filter entry and prints out a list of supported filters by the Mapillary API v4

Describe alternatives you've considered
Instead of logging the whole list of supported filters, the function can print out a list of close matches to the user's input filter.

Activity

  1. changed the title [-]Feature[/-] [+][Feature] Print supported filter types to users[/+] on Jul 9, 2021
  2. Rubix982 commented on Jul 11, 2021

    @Rubix982
    Contributor

    "...prints out a list of supported filters by the Mapillary API v4"

    By this, do you mean that a high-level filter function should return a list of possible filters?

    "... close matches to the user's input filter."

    We can use the Levenshtein edit distance algorithm!

  3. cbeddow commented on Jul 13, 2021

    @cbeddow
    Contributor

    Using close matches/Levenshtein for this would be outstanding, far beyond what I think a typical open source library might do in an early stage! Most probably would just return "check filter and try again" with no other info. Having the suggestions would be a great way to keep users focused and help them make quick fixes. Cool idea.

  4. Rubix982 commented on Jul 13, 2021

    @Rubix982
    Contributor

    Yes! Finally, my knowledge about data structures and algorithms pays off! :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

featureA feature request for the SDK

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions