search

MarcusBarnes / mik

The Move to Islandora Kit is an extensible PHP command-line tool for converting source content and metadata into packages suitable for importing into Islandora (or other digital repository and preservations systems).
GNU General Public License v3.0
34 stars 11 forks source link

Limit package generation - what is expected behaviour? #475

Closed bondjimbond closed 6 years ago

bondjimbond commented 6 years ago

Bringing this up in a new issue, since #445 is closed and this is a separate topic.

If I set --limit 5 in my test run, and objects at lines 1 and 4 are "problem records", MIK will skip over them and generate packages for 2, 3, 5, 6, and 7.

My expectation, since I use the limit option for testing, is that MIK should produce packages for only 2, 3, and 5, showing that objects 1 and 4 failed... that is, my interpretation of the --limit 5 parameter is "Try the first five objects and return the results". MIK's interpretation is "Run MIK, and return 5 successful packages."

Both interpretations are valid, but what would you think is the average user's expectation?

mjordan commented 6 years ago

I think we can define expectations by better documentation. The --limit option is intended for testing. I see the results you describe as valid test results: they identify some problem objects and also produce X good packages. Plus I think documenting the current behavior will take a lot less time and effort than changing code.

bondjimbond commented 6 years ago

@mjordan Sounds good to me.