Skip to content

Updated API reference docs: Removed deprecated functions (where and object) #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgilland merged 1 commit into from
Oct 28, 2025
Merged

Updated API reference docs: Removed deprecated functions (where and object) #238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ This is the recommended way to use pydash.

# OK (importing main module)
import pydash
pydash.where({})
pydash.filter_({})

# OK (import from main module)
from pydash import where
where({})
from pydash import filter_
filter_({})

# NOT RECOMMENDED (importing from submodule)
from pydash.collections import where
from pydash.collections import filter_


Only the main pydash module API is guaranteed to adhere to semver. It's possible that backwards incompatibility outside the main module API could be broken between minor releases.
Expand Down Expand Up @@ -70,7 +70,6 @@ The ``py_`` instance is basically a combination of using ``pydash.<function>`` a

A full listing of aliased ``py_`` methods:

- ``_.object`` is :func:`pydash.arrays.object_`
- ``_.slice`` is :func:`pydash.arrays.slice_`
- ``_.zip`` is :func:`pydash.arrays.zip_`
- ``_.all`` is :func:`pydash.collections.all_`
Expand Down