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: update draft doc for formatting #10393

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

stevekuznetsov
Copy link
Contributor

I think some automatic formatter added the {' '} styling, it doesn't render correctly. Update the formatting for this banner to remove it and correctly refer to the _status field.

I think some automatic formatter added the `{' '}` styling, it doesn't
render correctly. Update the formatting for this banner to remove it and
correctly refer to the `_status` field.

Signed-off-by: Steve Kuznetsov <[email protected]>
These blocks do not render correctly in the docs.

Signed-off-by: Steve Kuznetsov <[email protected]>
@stevekuznetsov
Copy link
Contributor Author

Example of improper formatting that {' '} causes, live on docs now:

Screenshot from 2025-01-06 10-09-02

**validate** function, the api will not validate **filterOptions**{' '}
unless you call the default upload field validation function imported from{' '}
When an upload field has both **filterOptions** and a custom
**validate** function, the api will not validate **filterOptions**
Copy link
Contributor Author

@stevekuznetsov stevekuznetsov Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably a question for another PR, but not clear to me when the docs use bold styling for these versus code blocks ("validate function" vs "validate function")

@AlessioGr AlessioGr enabled auto-merge (squash) January 10, 2025 08:08
@AlessioGr AlessioGr merged commit a8d6f3f into payloadcms:main Jan 10, 2025
12 checks passed
Copy link
Contributor

🚀 This is included in version v3.16.0

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

Successfully merging this pull request may close these issues.

2 participants