bluesky / tiled

API to structured data
https://blueskyproject.io/tiled
BSD 3-Clause "New" or "Revised" License
55 stars 48 forks source link

Should we rename the `FullText` query to just `Text`? #643

Open danielballan opened 6 months ago

danielballan commented 6 months ago

I think FullText is both verbose and a bit technical; maybe just plain Text would be better.

I also anticipate adding FuzzyText in the near future, with @Kezzsim's TypeSense work, and we wouldn't want FuzzyFullText....

padraic-shafer commented 6 months ago

I think FullText conveys more authoritatively than Text that all of the metadata is being queried.

As far as FuzzyFullText and variants go, maybe an import alias is the right tradeoff for CLI usage?

import FuzzyFullText as Fuzzy
padraic-shafer commented 6 months ago

...or maybe Search and FuzzySearch are both simple and well understood?

danielballan commented 6 months ago

You make a decent point about FullText. I worry about Search being too generic, as illustrated by the usage:

c.search(Search(...))