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

Comments

Projects
None yet
5 participants
@gibson042
Member

gibson042 commented May 15, 2015

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

This comment has been minimized.

Show comment
Hide comment
@timmywil

timmywil May 15, 2015

Member

That seems like a good place.

Member

timmywil commented May 15, 2015

That seems like a good place.

@markelog

This comment has been minimized.

Show comment
Hide comment
@markelog

markelog May 16, 2015

Member

So boo plain objects, right?

Member

markelog commented May 16, 2015

So boo plain objects, right?

@dmethvin

This comment has been minimized.

Show comment
Hide comment
@dmethvin

dmethvin Nov 6, 2015

Member

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

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 added a commit to gibson042/jquery that referenced this issue Nov 7, 2015

@timmywil timmywil closed this in 6054139 Jan 13, 2016

@mgol mgol removed the Has Pull Request label Mar 6, 2016

@lock lock bot locked as resolved and limited conversation to collaborators Jun 18, 2018

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