Deprecate render_document_partials. #2546
Conversation
|
It's also used quite a bit in overrides: https://github.com/search?q=render_document_partials&type=code As a kindness to upgraders, maybe it's worth keeping around in 8.x with a deprecation warning? 👍 to removing the atom xml dependency on it, though |
jcoyne
force-pushed
the
remove-document-partials
branch
from
2cc68bd
to
fe1abaf
Compare
jcoyne
changed the title
jcoyne
force-pushed
the
remove-document-partials
branch
2 times, most recently
from
2250c97
to
41653d2
Compare
|
@cbeer sounds good, I've switched it to a deprecation. |
jcoyne
force-pushed
the
remove-document-partials
branch
from
41653d2
to
d8bbc60
Compare
| @@ -22,6 +25,7 @@ def render_document_partials(doc, partials = [], locals = {}) | |||
| render_document_partial(doc, action_name, locals) | |||
| end, "\n") | |||
| end | |||
| deprecation_deprecate render_document_partials: 'Render the document_component instead' | |||
There was a problem hiding this comment.
What does this mean? If I get this error I'm not sure what to do. Can we expand this deprecation error? Or if I just put in render_document_component instead of render_document_partials it'll be good?
There was a problem hiding this comment.
that would be a rather long message to stick here:
Replace this call with:
"document_component = blacklight_config.view_config(:atom).summary_component
render document_component.new(presenter: document_presenter(document), component: :div, show: true)" instead.
This assumes that the current context has a document_presenter and blacklight_config helpers and that :atom is the current config context.
There was a problem hiding this comment.
I might be in the minority here, but I'm 👍 to that long message. Changing it to "Replace this call with a document component render, e.g: allthat" might be nice to be more clear?
This was only used by the atom partial renderer. We can replace this with the document component
Fixes #2537