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

Document "invocation correctness" development principle #2320

Closed
gibson042 opened this issue May 15, 2015 · 3 comments
Closed

Document "invocation correctness" development principle #2320

gibson042 opened this issue May 15, 2015 · 3 comments
Labels

Comments

@gibson042
Copy link
Member

Ref #2134 (comment)

We now (modulo particularly hairy backwards compatibility issues) consider it safe to assume that all function input matches a documented signature, and therefore allow functions to throw exceptions rather than fail silently. This should be captured somewhere, and my first thought was CONTRIBUTING.md.

@gibson042 gibson042 added the Docs label May 15, 2015
@timmywil
Copy link
Member

That seems like a good place.

@markelog
Copy link
Member

So boo plain objects, right?

@dmethvin
Copy link
Member

dmethvin commented Nov 6, 2015

I started a wiki page that we can use to iterate, it might be a little easier to do there than on a PR. Or maybe harder, I dunno, but you can just start editing with your ideas if you want. People don't generally read any of this, so usually it will be us linking to it to justify not changing (or changing) some reported behavior.

https://github.com/jquery/jquery/wiki/API-design-guidelines

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Development

No branches or pull requests

5 participants