Api docs parameter default extraction removes parts of the description

[ST-DDT]

Describe the bug

Found while reviewing #792 (comment) and writing #793.

faker/scripts/apidoc/signature.ts

Lines 301 to 305 in 81171c9

	const result = /(.*)[ \n]Defaults to `([^`]+)`./.exec(text);
	if (!result) {
	return;
	}
	comment.shortText = result[1];

The code removes the description after the parameter default section.

Reproduction

faker/src/time.ts

Lines 13 to 18 in 81171c9

	* @param format The format to use. Defaults to `'unix'`.
	*
	* - `'abbr'` Return a string with only the time. `Date.toLocaleTimeString`.
	* - `'date'` Return a date instance.
	* - `'wide'` Return a string with a long time. `Date.toTimeString()`.
	* - `'unix'` Returns a unix timestamp.

Additional Info

Possible solutions:

1. Require the default to be the last segment
2. Fix the code to not erase the suffix
3. Intentionally ignore the parts after the defaults (not recommended)

[Shinigami92]

I would love to go with 1. Require the default to be the last segment so we have a specific convention.

[ST-DDT]

So the docs should fail if it's specified otherwise?

[Shinigami92]

So the docs should fail if it's specified otherwise?

I assume yes, not the docs should fail, but the generation of the docs should.