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

Extract 'Extensibility of the API' #72

Closed
wants to merge 1 commit into from

Conversation

ewilligers
Copy link
Collaborator

@ewilligers ewilligers commented Feb 20, 2018

The chapter 'Extensibility of the API' is moved into a separate
document. It remains available as a resource for informing future
evolution of the specification, without itself being part of the
specification.

resolves #61


Preview | Diff

The chapter 'Extensibility of the API' is moved into a separate
document. It remains available as a resource for informing future
evolution of the specification, without itself being part of the
specification.

resolves w3c#61
Copy link
Collaborator

@mgiuca mgiuca left a comment

Choose a reason for hiding this comment

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

I'll have to think about this.

I liked having it be a non-normative part of the spec, because it establishes rules about how the API can evolve. If nothing else, it provides a non-normative explanation of why we throw a TypeError when the dictionary passed to share() is empty (for future-proofing) which I think is important to capture in the spec proper.

If we are removing this, we should at least add a note to share() why this is the case (it is non-obvious why it should be valid to pass unrecognised keys, but an error to pass no recognised keys, but it is by design).

@@ -0,0 +1,79 @@
<!DOCTYPE html>
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this is going to go in a separate, informal, document, then:

  1. It should go in /docs.
  2. I think it should just be a plain Markdown file (like the other informal docs in that directory), rather than a Respec-formatted doc.

Base automatically changed from master to main February 3, 2021 03:22
@ewilligers ewilligers deleted the extending branch June 7, 2022 08:52
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.

Extensibility of the API section could be removed
4 participants