Rename parameter check to filter

Author: sweetbrulee

CHANGELOG.md

@@ -22,7 +22,7 @@ These changes are available on the `master` branch, but have not yet been releas
   `tags`. ([#2520](https://github.com/Pycord-Development/pycord/pull/2520))
 - Added `Member.guild_banner` and `Member.display_banner` properties.
   ([#2556](https://github.com/Pycord-Development/pycord/pull/2556))
-- Added optional `check` parameter in `utils.basic_autocomplete`.
+- Added optional `filter` parameter in `utils.basic_autocomplete`.
   ([#2590](https://github.com/Pycord-Development/pycord/pull/2590))
 
 ### Fixed

discord/utils.py

@@ -1306,11 +1306,11 @@ def generate_snowflake(dt: datetime.datetime | None = None) -> int:
 AV = Awaitable[V]
 Values = Union[V, Callable[[AutocompleteContext], Union[V, AV]], AV]
 AutocompleteFunc = Callable[[AutocompleteContext], AV]
-CheckFunc = Callable[[AutocompleteContext, Any], Union[bool, Awaitable[bool]]]
+FilterFunc = Callable[[AutocompleteContext, Any], Union[bool, Awaitable[bool]]]
 
 
 def basic_autocomplete(
-    values: Values, *, check: CheckFunc | None = None
+    values: Values, *, filter: FilterFunc | None = None
 ) -> AutocompleteFunc:
     """A helper function to make a basic autocomplete for slash commands. This is a pretty standard autocomplete and
     will return any options that start with the value from the user, case-insensitive. If the ``values`` parameter is
@@ -1323,9 +1323,9 @@ def basic_autocomplete(
     values: Union[Union[Iterable[:class:`.OptionChoice`], Iterable[:class:`str`], Iterable[:class:`int`], Iterable[:class:`float`]], Callable[[:class:`.AutocompleteContext`], Union[Union[Iterable[:class:`str`], Iterable[:class:`int`], Iterable[:class:`float`]], Awaitable[Union[Iterable[:class:`str`], Iterable[:class:`int`], Iterable[:class:`float`]]]]], Awaitable[Union[Iterable[:class:`str`], Iterable[:class:`int`], Iterable[:class:`float`]]]]
         Possible values for the option. Accepts an iterable of :class:`str`, a callable (sync or async) that takes a
         single argument of :class:`.AutocompleteContext`, or a coroutine. Must resolve to an iterable of :class:`str`.
-    check: Optional[Callable[[:class:`.AutocompleteContext`, Any], Union[:class:`bool`, Awaitable[:class:`bool`]]]]
+    filter: Optional[Callable[[:class:`.AutocompleteContext`, Any], Union[:class:`bool`, Awaitable[:class:`bool`]]]]
         Predicate callable (sync or async) used to filter the autocomplete options. This function should accept two arguments:
-        the :class:`.AutocompleteContext` and an item from ``values``. If ``None`` is provided, a default check is used that includes items whose string representation starts with the user's input value, case-insensitive.
+        the :class:`.AutocompleteContext` and an item from ``values``. If ``None`` is provided, a default filter is used that includes items whose string representation starts with the user's input value, case-insensitive.
 
     Returns
     -------
@@ -1361,22 +1361,22 @@ async def autocomplete_callback(ctx: AutocompleteContext) -> V:
         if asyncio.iscoroutine(_values):
             _values = await _values
 
-        if check is None:
+        if filter is None:
 
-            def _check(ctx: AutocompleteContext, item: Any) -> bool:
+            def _filter(ctx: AutocompleteContext, item: Any) -> bool:
                 item = getattr(item, "name", item)
                 return str(item).lower().startswith(str(ctx.value or "").lower())
 
-            gen = (val for val in _values if _check(ctx, val))
+            gen = (val for val in _values if _filter(ctx, val))
 
-        elif asyncio.iscoroutinefunction(check):
-            gen = (val for val in _values if await check(ctx, val))
+        elif asyncio.iscoroutinefunction(filter):
+            gen = (val for val in _values if await filter(ctx, val))
 
-        elif callable(check):
-            gen = (val for val in _values if check(ctx, val))
+        elif callable(filter):
+            gen = (val for val in _values if filter(ctx, val))
 
         else:
-            raise TypeError("``check`` must be callable.")
+            raise TypeError("``filter`` must be callable.")
 
         return iter(itertools.islice(gen, 25))