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

Improve Documentation #2845 - lexical/list #4107

Merged
merged 3 commits into from
Mar 14, 2023

Conversation

HarrySIV
Copy link
Contributor

@HarrySIV HarrySIV commented Mar 12, 2023

This PR adds documentation to the lexical/list module @ files: formatList.ts, LexicalListItemNode.ts, LexicalListNode.ts, and utils.ts.

@vercel
Copy link

vercel bot commented Mar 12, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
lexical ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 12, 2023 at 6:27PM (UTC)
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 12, 2023 at 6:27PM (UTC)

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Mar 12, 2023
Copy link
Member

@zurfyx zurfyx left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for for the detailed documentation! @acywatson, mind having a pass to it since you know more about the impl details behind insertList/removeList and some other methods?

@HarrySIV
Copy link
Contributor Author

Thank you! I will say, I was a bit worried about over explaining the logic, there are a lot of nested if checks and I didn't know if it was more helpful to be specific or general in some cases.

@acywatson acywatson merged commit 7c249fe into facebook:main Mar 14, 2023
@HarrySIV HarrySIV deleted the api-docs-list branch March 14, 2023 04:13
@zurfyx zurfyx mentioned this pull request Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants