Document "invocation correctness" development principle #2320

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

Projects

None yet

5 participants

@gibson042
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
Member

That seems like a good place.

@markelog
Member

So boo plain objects, right?

@dmethvin
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

@gibson042 gibson042 added a commit to gibson042/jquery that referenced this issue Nov 7, 2015
@gibson042 gibson042 Docs: Reference new feature guidelines and API tenets
Fixes gh-2320
6ec0cb4
@timmywil timmywil pushed a commit that closed this issue Jan 13, 2016
@gibson042 gibson042 + Timmy Willison Docs: Reference new feature guidelines and API tenets
Fixes gh-2320
Close gh-2697
6054139
@timmywil timmywil closed this in 6054139 Jan 13, 2016
@mgol mgol removed the Has Pull Request label Mar 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment