Project

General

Profile

Bug #11301

Lua API documentation for event intermediate-export-image has wrong parameter count/types

Added by James Bowen over 3 years ago. Updated over 3 years ago.

Status:
Closed: invalid
Priority:
Low
Assignee:
-
Category:
Usermanual
Target version:
Start date:
11/09/2016
Due date:
% Done:

0%

Estimated time:
Affected Version:
2.2.0rc0
System:
Ubuntu
bitness:
64-bit
hardware architecture:
amd64/x86

Description

Per docs at https://www.darktable.org/lua-api/ar01s03.html.php#events_intermediate-export-image, the expected arguments to the callback function for the intermediate-export-image event are the following:

function( 
    event : string, 
    image : types.dt_lua_image_t, 
    filename : string, 
    format : types.dt_imageio_module_format_t, 
    storage : types.dt_imageio_module_storage_t
)

In practice (and confirmed in the code), image is not one of the arguments sent to the callback.

While the bug is in the documentation not matching the code, it may be more beneficial if the API were implemented per the documentation as having the full image object is useful.

Noticed in 2.0.7 but appears to be unchanged in 2.2.0rc0 and master as well

History

#1 Updated by Roman Lebedev over 3 years ago

  • Status changed from New to Closed: invalid

James Bowen wrote:

Per docs at https://www.darktable.org/lua-api/ar01s03.html.php#events_intermediate-export-image

From https://www.darktable.org/lua-api/index.html.php#darktable
"This documentation for API version 3.0.0."

In git master, lua api version is 4.0.0

, the expected arguments to the callback function for the intermediate-export-image event are the following:

[...]

In practice (and confirmed in the code), image is not one of the arguments sent to the callback.

While the bug is in the documentation not matching the code, it may be more beneficial if the API were implemented per the documentation as having the full image object is useful.

Noticed in 2.0.7 but appears to be unchanged in 2.2.0rc0 and master as well

#2 Updated by Roman Lebedev over 3 years ago

  • Target version set to 2.2.0

Also available in: Atom PDF

Go to top