Document that setting will be rounded to one of the settings options.

2022-09-02 16:20:51 -04:00
parent e6f363a0f6
commit 236216b556
3 changed files with 6 additions and 0 deletions
--- a/src/config/browse-by-config.interface.ts
+++ b/src/config/browse-by-config.interface.ts
@@ -25,6 +25,8 @@ export interface BrowseByConfig extends Config {

  /**
   * Number of entries in the viewport of a paginated browse-by list.
+   * Rounded to the nearest size in the list of selectable sizes on the settings
+   * menu.  See pageSizeOptions in 'pagination-component-options.model.ts'.
   */
   pageSize: number;
 }