render_cell documentation example doesn't match the method signature

[pjamargh]

Open Datasette stable doc at https://docs.datasette.io/en/stable/plugin_hooks.html?highlight=render_cell#render-cell-row-value-column-table-database-datasette

render_cell plugin hook method signature is render_cell(row, value, column, table, database, datasette), the example shown inline uses render_cell(value).

[simonw]

This is deliberate. The Datasette plugin system allows you to specify only a subset of the parameters for a hook - in this example, only the value is needed so the others can be omitted.

There's a note about this at the very top of that documentation page: https://docs.datasette.io/en/stable/plugin_hooks.html#plugin-hooks

When you implement a plugin hook you can accept any or all of the parameters that are documented as being passed to that hook.

For example, you can implement the render_cell plugin hook like this even though the full documented hook signature is render_cell(value, column, table, database, datasette):

@hookimpl
def render_cell(value, column):
    if column == "stars":
        return "*" * int(value)

[simonw]

Though now I notice that the copy right there needs to be updated to reflect the new row parameter to render_cell!

[pjamargh]

I'm glad the bug report served some purpose. Frankly I just needed the method signature, that is why the documentation you mention wasn't read.

…

On Tue, Sep 27, 2022, 9:05 PM Simon Willison ***@***.***> wrote: Though now I notice that the copy right there needs to be updated to reflect the new row parameter to render_cell! — Reply to this email directly, view it on GitHub <#1826 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AP46PCLI6KVDQTFLWVZODRLWAO72JANCNFSM6AAAAAAQXKWIJA> . You are receiving this because you authored the thread.Message ID: ***@***.***>