Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs props interface lists "See: [object Object]" #7001

Closed
ggdouglas opened this issue Sep 25, 2024 · 1 comment
Closed

Docs props interface lists "See: [object Object]" #7001

ggdouglas opened this issue Sep 25, 2024 · 1 comment

Comments

@ggdouglas
Copy link
Contributor

ggdouglas commented Sep 25, 2024

Environment

  • Package version(s): 5.13.0

Description

Some components have the string "See: [object Object]" listed in the props description of the docs. For example:

DatePicker3 - https://blueprintjs.com/docs/#datetime2/date-picker3.props-interface (locale prop)

If you provide a locale code string and receive a loading error, please make sure it is included in the list of date-fns' supported locales.
See: [object Object]

Screenshot 2024-09-25 at 16 19 34@2x

DateInput3 - https://blueprintjs.com/docs/#datetime2/date-input3.props-interface (dateFnsFormat prop)

Mutually exclusive with the formatDate and parseDate props.
See: [object Object]

Screenshot 2024-09-25 at 16 18 20@2x

Possible solution

It looks like the documentation build isn't correctly processing JSDoc @see tags linking to external sites:

/**
* date-fns `Locale` object or locale code string ((ISO 639-1 + optional country code) which will be used
* to localize the date picker.
*
* If you provide a locale code string and receive a loading error, please make sure it is included in the list of
* date-fns' [supported locales](https://github.com/date-fns/date-fns/tree/main/src/locale).
*
* @default "en-US"
* @see https://date-fns.org/docs/Locale
*/
locale?: Locale | string;

/**
* [date-fns format](https://date-fns.org/docs/format) string used to format & parse date strings.
*
* Mutually exclusive with the `formatDate` and `parseDate` props.
*
* @see https://date-fns.org/docs/format
*/
dateFnsFormat?: string;

Investigate root cause in documentalist

@ggdouglas
Copy link
Contributor Author

Fixed by #7013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant