Skip to content

Clarify setting provenance in documentation page about filtering#9795

Merged
auvipy merged 1 commit intoencode:mainfrom
uche-wealth:main
Oct 9, 2025
Merged

Clarify setting provenance in documentation page about filtering#9795
auvipy merged 1 commit intoencode:mainfrom
uche-wealth:main

Conversation

@uche-wealth
Copy link
Contributor

I found it difficult locating where to override the SEARCH_PARAM setting when reading the docs:

By default, the search parameter is named 'search', but this may be overridden with the SEARCH_PARAM setting.

In order to help other users who might have this challenge, I added a clause to show that this setting can be overridden in the REST_FRAMEWORK settings. Same with ORDERING_PARAM.

Copy link
Member

@browniebroke browniebroke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's indeed implied, but explicit is better 👍

@auvipy auvipy merged commit a323cf7 into encode:main Oct 9, 2025
6 checks passed
@browniebroke browniebroke changed the title improved docs/api-guide/filtering.md for better understanding Clarify setting provenance in documentation page about filtering Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants