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.

Sign up for GitHub

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

Jump to bottom

Update to Lit 2.1 API documentation #623

Merged
merged 3 commits into from
Jan 5, 2022
Merged

Update to Lit 2.1 API documentation #623

merged 3 commits into from
Jan 5, 2022

Conversation

AndrewJakubowicz
Copy link
Contributor

@AndrewJakubowicz AndrewJakubowicz commented Dec 14, 2021 •
edited
Loading

Bump generated API docs so they include new Lit 2.1 features.

Example of a new section: https://pr623-b0bd433---lit-dev-5ftespv5na-uc.a.run.app/docs/api/decorators/#queryAssignedElements

Will merge after Lit 2.1 release.

@AndrewJakubowicz
Update to Lit 2.1 API documentation
b0bd433 
Includes queryAssignedElements.
@github-actions
Copy link

github-actions bot commented Dec 14, 2021 •
edited
Loading

A live preview of this PR will be available at the URL(s) below.
The latest URL will be appended to this comment on each push.
Each build takes ~5-10 minutes, and will 404 until finished.

https://pr623-b0bd433---lit-dev-5ftespv5na-uc.a.run.app/
https://pr623-b29ea71---lit-dev-5ftespv5na-uc.a.run.app/
https://pr623-cd871f6---lit-dev-5ftespv5na-uc.a.run.app/

aomarks
aomarks approved these changes Dec 14, 2021
View reviewed changes
Copy link
Member

@aomarks aomarks left a comment

Choose a reason for hiding this comment

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

Looks fine, but I did notice that the options.slot and options.selector parameters don't get documented.

I guess TypeDoc must consider those invalid, since they don't match any actual parameter.

It's slightly confusing right now, because the options descriptions just tell you to look at MDN, but the slot and selector options aren't documented there.

Also, we should merge this just after the release, I assume?

@AndrewJakubowicz
Copy link
Contributor Author

There is a confusingly link QueryAssignedElementsOptions at the top of the options but I don't find it intuitive to click. Maybe also making the slot and selector link to the options interface docs?

@aomarks
Copy link
Member

aomarks commented Dec 14, 2021

There is a confusingly link QueryAssignedElementsOptions at the top of the options but I don't find it intuitive to click. Maybe also making the slot and selector link to the options interface docs?

Oh, true! I think it was the phrasing of "See MDN parameters section for available options" that sounded authoritative -- like that was the only place I should look. Also the elements decorator says "Also accepts two more optional properties, slot and selector.", but the nodes one doesn't have a similar sentence.

@AndrewJakubowicz
Copy link
Contributor Author

This is a great comment. Will address on Lit core.

AndrewJakubowicz added a commit to lit/lit that referenced this pull request Dec 14, 2021
@AndrewJakubowicz
Improve generated docs to more clearly link to options object for que…
e84a576 
…ryAssignedNodes.

Raised in lit/lit.dev#623
@AndrewJakubowicz AndrewJakubowicz mentioned this pull request Dec 14, 2021
Merged
AndrewJakubowicz added a commit to lit/lit that referenced this pull request Dec 14, 2021
@AndrewJakubowicz
Improve generated docs to more clearly link to options object for que…
1b67e03 
…ryAssignedNodes.

Raised in lit/lit.dev#623
@AndrewJakubowicz
Copy link
Contributor Author

Thanks Al! Addressed your changes on Lit and updated the Lit 2 sha here to pull in the change.

aomarks
aomarks reviewed Dec 14, 2021
View reviewed changes
Copy link
Member

@aomarks aomarks left a comment

Choose a reason for hiding this comment

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

Should we be waiting to merge these PRs until we do the release? The docs won't match the released version otherwise, right?

@AndrewJakubowicz
Copy link
Contributor Author

Right! Blocked on Lit 2.1 release.

@AndrewJakubowicz AndrewJakubowicz changed the title Update to Lit 2.1 API documentation 🚧[WAIT FOR LIT 2.1 RELEASE]🚧 Update to Lit 2.1 API documentation Dec 14, 2021
@AndrewJakubowicz AndrewJakubowicz changed the title 🚧[WAIT FOR LIT 2.1 RELEASE]🚧 Update to Lit 2.1 API documentation Update to Lit 2.1 API documentation Jan 5, 2022
@AndrewJakubowicz
Document queryAssignedElements and update queryAssignedNodes (#616)
cd871f6 
* ocument queryAssignedElements first pass.

Addresses issues:
 - #607
 - #614

* Edit documentation

* Address feedback from Al. Also fix a bug.

* Update packages/lit-dev-content/site/docs/components/shadow-dom.md

Co-authored-by: Arthur Evans <arthure@google.com>

* Update packages/lit-dev-content/site/docs/components/shadow-dom.md

Co-authored-by: Arthur Evans <arthure@google.com>

* Arthur's feedback - make options into a table.

Co-authored-by: Andrew Jakubowicz <ajakubowicz@google.com>
Co-authored-by: Arthur Evans <arthure@google.com>
@AndrewJakubowicz AndrewJakubowicz merged commit d34bc89 into main Jan 5, 2022
@AndrewJakubowicz AndrewJakubowicz deleted the lit-2.1-api branch January 5, 2022 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aomarks aomarks aomarks approved these changes

@justinfagnani justinfagnani Awaiting requested review from justinfagnani

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@AndrewJakubowicz @aomarks