Add JSDOC @message param to broken error pages

[yanthomasdev]

Changes

Added JSDOC @message param to InvalidContentEntrySlugError & ContentSchemaContainsSlugError errors to fix their generated docs pages.

Before	After

The function we use in docs to extract the error messages from this file expects functions to follow this style:

message: (params: string) => `Message ${params}`,

These and a few other errors follow this, instead:

message: (configFile: string) => {
        return message: (params: string) => `Message ${params}`;
},

Not sure if this function style makes a difference in the core side of things, if possible I'd advocate going with the former function style so we avoid possible errors (and if it can't be avoided, to use @message for these error messages).

When available, the docs doc gen script uses the JSDOC @message param instead, so I added it to the problematic functions as a fix. Also because they have dynamic values we can't bring to docs (like the current collection or entryId), in which case, it's better to use JSDoc anyway to overwrite these values with COLLECTION_NAME and ENTRY_ID, for extra clarity.

Testing

Only JSDOC comments, shouldn't affect code behavior.

Docs

It's all docs baby 😎

cc @withastro/maintainers-docs for feedback!

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1e0e146

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[hippotastic]

LGTM and fixes the issue in docs!

[bholmesdev]

Gotcha, will doctor up our errors with @message in the future!