Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Add API summary to README.md #170

Open
cpcallen opened this issue Nov 18, 2019 · 2 comments
Open

Add API summary to README.md #170

cpcallen opened this issue Nov 18, 2019 · 2 comments
Labels
documentation

Comments

@cpcallen
Copy link
Contributor

The examples (and copious warnings) in the README are great, but it would be helpful if it included an MDN-style summary of the proposed API.

  • It would make it easier to understand the spec text.
  • Knowing what the spec is intended to mean could make it easier to spot errors in the text, if any still exist.
  • It could help highlight the multiple uses of FinalizationGroup hinted at in Rename WeakFactory to FinalizationGroup #49.
  • It would help MDN and others when they come to document the feature in future.
@littledan
Copy link
Member

Good idea. PRs welcome!

@littledan littledan mentioned this issue Mar 4, 2020
Open
@littledan
Copy link
Member

Documentation added in #196 . Further reviews welcome!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@littledan @cpcallen