docs(createQuerySuggestionsPlugin): rewrite docs

[sarahdayan]

This rewrites the createQuerySuggestionsPlugin docs.

[sarahdayan]

Broken unit tests are caused by 752afd8 which broke the build.

[francoischalifour]

There are additional params since the doc creation:

autocomplete/packages/autocomplete-plugin-query-suggestions/src/createQuerySuggestionsPlugin.ts

Lines 23 to 38 in 612b040

	/**
	* The attribute or attribute path to display categories.
	* @example ["instant_search", "facets", "exact_matches", "categories"]
	* @example ["instant_search", "facets", "exact_matches", "hierarchicalCategories.lvl0"]
	*/
	categoryAttribute?: string | string[];
	/**
	* The number of items to display categories for.
	* @default 1
	*/
	categoriesLimit?: number;
	/**
	* The number of categories to display per item.
	* @default 1
	*/
	categoriesPerItem?: number;

[sarahdayan]

There are additional params since the doc creation:

Addressed in 4d429df.

[francoischalifour]

I wrote this description myself quickly but not sure it's very comprehensible. Wdyt?

[sarahdayan]

Can you quickly describe it to make sure it's clear to me?

[francoischalifour]

(With categoriesPerItem: 2)

categoriesLimit: 1

categoriesLimit: 3

[sarahdayan]

Got it! It's how many items get categories. I'm wondering if the name of the parameter is optimal though. Now that I know what it is, categoriesLimit still doesn't convey that idea. Have you thought of something more descriptive like itemsWithCategories? It doesn't convey as much that it expects a number but it's clearer.

[francoischalifour]

Yeah I'm not convinced by the name either.

How about those?

• numberOfItemsWithCategories
• numberOfCategoriesPerItem

[sarahdayan]

I find numberOf superfluous, the type conveys this information already.

• itemsWithCategories
• categoriesPerItem

This is simpler.

[francoischalifour]

OK—I'll take care of that in another PR.