Work out how to document different plural rules in the Nunjucks option table for the Character Count about govuk-design-system HOT 3 CLOSED

I don't think there's anything currently built in that would allow us to document the params in the YAML but only have them included in the Nunjucks macro options only once.

If we wanted to do the 'easiest thing' we could include the various pluralisable phrases in the YAML, document them as 'objects', but not to list the individual params in the YAML file. Instead we could put a link in the description to somewhere else (in the frontend docs?) where we can explain how they work in more detail.

Something like:

- name: charactersOverLimitText
  type: object
  required: false
  description: Override the phrases used when the user has entered a number of characters that exceeds the limit. See [Understanding pluralisation rules](https://frontend.design-system.service.gov.uk/localising-govuk-frontend#understanding-pluralisation-rules).
- name: charactersUnderLimitText
  type: object
  required: false
  description: Override the phrases used when the user has entered a number of characters that is under the limit. See [Understanding pluralisation rules](https://frontend.design-system.service.gov.uk/localising-govuk-frontend#understanding-pluralisation-rules).

There's lots of reasons why this might be confusing (it's inconsistent with how we document other options with known key/value pairs, for example) but it wouldn't avoid any code changes.

from govuk-design-system.

Do I remember correctly that, when we met to discuss this, we agreed to get started using Ollie's solution of linking to wherever the documentation about pluralisation lives?

If so, let's remove this issue from the milestone 😄 I'd be keen to keep it open, as we may want to work out how not to send people somewhere else (unless there's a wider issue for addressing the rendering of that Nunjucks table).

from govuk-design-system.

We're adding links between the options table and the pluralisation rules. The URLs will need to be double-checked once the documentation is added in a PR.

from govuk-design-system.