Skip to content
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.

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

Search block - File block: Add deprecated vars to render_callback functions #58432

Closed

Conversation

cbravobernal
Copy link
Contributor

What?

In last Interactivity API changes, we added-removed the three variables that are passed through the render_callback.
As these functions may be have been used by external developers, we need to "deprecate them", but only in the docs.

_deprecated_argument is not being used, cause if it is added, it will appear in all blocks rendered, as the callback is always passing those values (even if they are not being used)

Doing this:
Screenshot 2024-01-29 at 18 36 29

Would cause this:
Screenshot 2024-01-29 at 18 35 26

So the cleanest way to deal with this issue is to leave the variables, skip the linting issue, and add them as deprecated in the docs.

@cbravobernal cbravobernal added [Type] Code Quality Issues or PRs that relate to code quality [Block] File Affects the File Block [Block] Search Affects the Search Block - used to display a search field labels Jan 30, 2024
@cbravobernal cbravobernal self-assigned this Jan 30, 2024
@youknowriad
Copy link
Contributor

To be honest, I think this PR is not needed because if third-parties were using these functions with more arguments and they are still passing them, it won't break, it's just that the arguments won't be used which is totally fine. So IMO, we should just close this PR but would love input from @desrosj

@youknowriad youknowriad closed this Feb 7, 2024
@youknowriad youknowriad deleted the update/prevent_render_functions_compatibility branch February 7, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] File Affects the File Block [Block] Search Affects the Search Block - used to display a search field [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants