documentation includes misleading example for circulation policies

[Rosie Le Faive]

The page "Borrowing items: who, what, for how long" is very very useful. However, the image "Example 1" is misleading.

3.4: https://docs.evergreen-ils.org/docs/3.4/_creating_circulation_policies.html
3.6: https://docs.evergreen-ils.org/eg/docs/3.6/admin_initial_setup/borrowing_items.html

The image in question: https://docs.evergreen-ils.org/eg/docs/3.6/admin_initial_setup/_images/media/circ_example1.png

That image is used as an example of a consortial policy that does not charge fines, but one library within that system does. The first row is the no-fines policy and reads:

org_unit: CONS
duration_rule: 21_day_2_renew
recurring_fine_rule: NONE
max_fine_rule: NONE

I tried to implement this, and broke my library's ability to circulate items. I interpreted NONE as NULL, and removed the recurring_fine_rule in the circulation_matchpoint_matrix table. Then when someone tried to circulate an item that would use that policy, we got the error "no_matchpoint".

Sure enough, a reading of action.find_circ_matrix_matchpoint(context_ou integer, item_object asset.copy, user_object actor.usr, renewal boolean) says that the required fields for a matchpoint to be found are: circulate, duration_rule, recurring_fine_rule, max_fine_rule.

Unless the mandatory fields have changed, then the example would be more clear if it read:

org_unit: CONS
duration_rule: 21_day_2_renew
recurring_fine_rule: 0c_pd
max_fine_rule: 0d_max_fine

which are the "zero" valued fine rules in the screenshots above (in the 3.6 documentation).

Also: The 3.6 documentation on that page is very good, much gratitude to the folks who worked on it.

[Gina Monti (gmonti90)]

Branch: https://github.com/evergreen-library-system/Evergreen/pull/244

I decided to also format the rest of the images into tables since these aren't actually screenshots (at least from what I was able to tell).

[Andrea Neiman (aneiman)]

Committed to main and backported through rel_3_10. Thanks Gina!