Skip to content

Add docs for request param overrides#7276

Closed
CamronStaley wants to merge 1 commit intodevelopfrom
docs/request-parap-overrides
Closed

Add docs for request param overrides#7276
CamronStaley wants to merge 1 commit intodevelopfrom
docs/request-parap-overrides

Conversation

@CamronStaley
Copy link
Copy Markdown
Contributor

@CamronStaley CamronStaley commented Mar 31, 2026

🔗 Related Issues

📋 What changes are proposed in this pull request?

Update docs for request param overrides.

🧪 How is this patch tested? If it is not, please explain why.

n/a

📝 Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

Added instructions to docs for how to use request param overrides in pipeline operators.

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

Documentation

  • Added comprehensive documentation explaining how pipeline stages can override inherited request parameters, including detailed specifications of which parameters are overridable and how stage-level overrides affect individual stages without impacting other pipeline stages.
  • Included practical code examples demonstrating stage-level configuration techniques with multiple pipeline stages.
  • Added clarification notes on proper parameter placement within stage configuration.

@CamronStaley CamronStaley self-assigned this Mar 31, 2026
@CamronStaley CamronStaley requested a review from a team as a code owner March 31, 2026 15:14
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 7937262a-a9b4-4a7b-8b16-ef28dc356159

📥 Commits

Reviewing files that changed from the base of the PR and between 14c9ad2 and 927f214.

📒 Files selected for processing (1)
  • docs/source/plugins/developing_plugins.rst

Walkthrough

This pull request adds documentation explaining how PipelineStage can override inherited request parameters through request_params_overrides. The addition clarifies that stage-level overrides shadow pipeline-level values only for that specific stage, specifies which parameters are overridable (view, view_name, filters, and other execution-context request parameters), includes a note preventing placement of params inside request_params_overrides, and provides a code example demonstrating three stages with different view contexts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for request parameter overrides, which is the sole focus of this documentation-only pull request.
Description check ✅ Passed The description covers all required template sections with appropriate content: related issues acknowledged as empty, changes clearly stated, testing properly marked as n/a for docs, and release notes properly completed with user-facing change details and affected areas marked.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/request-parap-overrides

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@swheaton swheaton left a comment

Choose a reason for hiding this comment

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

looks fine to me but we will want to target main after today's release so that the docs are added to the site quickly

@CamronStaley CamronStaley changed the base branch from develop to main March 31, 2026 15:21
@CamronStaley CamronStaley requested review from a team and sashankaryal as code owners March 31, 2026 15:21
@CamronStaley CamronStaley changed the base branch from main to develop March 31, 2026 15:22
@CamronStaley
Copy link
Copy Markdown
Contributor Author

moved here was a bunch of conflicts and the branch has a typo in the name anyways: #7277

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants