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(new): Start documenting the Page class #6001

Merged
merged 1 commit into from Jun 12, 2020
Merged

Conversation

jackfranklin
Copy link
Collaborator

This PR starts exploring the Page class and how to best document it. It explores how best to document events in the system, and I think pulling them out into an enum is the best solution here. It lets us end up with a page of docs that explicitly lists all the events the page class can ever emit.

@mathiasbynens
Copy link
Member

Nit for the commit message: feat(new-docs):docs(new):. (feat is for new user-facing features/APIs.)

This PR starts exploring the Page class and how to best document it. It explores how best to document events in the system, and I think pulling them out into an `enum` is the best solution here. It lets us end up with a page of docs that explicitly lists all the events the page class can ever emit.
@jackfranklin jackfranklin changed the title feat(new-docs): Start documenting the Page class docs(new): Start documenting the Page class Jun 12, 2020
@jackfranklin jackfranklin merged commit 23f18d8 into master Jun 12, 2020
@jackfranklin jackfranklin deleted the document-page branch June 12, 2020 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants