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.

Sign up for GitHub

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

Jump to bottom

Document exceptions #7012

Closed
denisz1 opened this issue Nov 14, 2016 · 1 comment
Closed

Document exceptions #7012

denisz1 opened this issue Nov 14, 2016 · 1 comment
Assignees
@ajcvickers
Labels
closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. type-bug
Milestone
2.0.0

Comments

@denisz1
Copy link

denisz1 commented Nov 14, 2016 •
edited
Loading

MS SDKs typically document which exceptions are thrown.

This is crucial information. We cannot properly handle our error paths without knowing what is going wrong (and catching an Exception tells us nothing).

Many EF Core methods lack complete documentation, because they do not mention exceptions thrown. MSDN was good at this, but the new docs site seems incomplete.

These are the worst culprits:

DbContext.SaveChanges
DbContext.SaveChangesAsync

We cannot rely on the source, because that can change at any time. You need to officially document this.

It's not hard, PLEASE consider this a priority.

(In the meantime, please at least let us know about those two methods.)
@rowanmiller rowanmiller added this to the 1.2.0 milestone Nov 14, 2016
@rowanmiller rowanmiller self-assigned this Nov 14, 2016
@rowanmiller
Copy link
Contributor

Note to self - look for custom exception types that we have defined

@ajcvickers ajcvickers modified the milestones: 2.0.0-preview1, 2.0.0 Apr 19, 2017
ajcvickers added a commit that referenced this issue Jun 26, 2017
@ajcvickers
Add exception documentation for SaveChanges
ffd745c 
Issue #7012

Text is copied from the documentation for the exception types.
Also checked that there are no other custom exception types used at runtime that do not have similar documentation. All other exceptions indicate a program/logic error, not a recoverable state, and use built-in exception types.
@ajcvickers ajcvickers mentioned this issue Jun 26, 2017
Merged
ajcvickers added a commit that referenced this issue Jun 26, 2017
@ajcvickers
Add exception documentation for SaveChanges
68ef618 
Issue #7012

Text is copied from the documentation for the exception types.
Also checked that there are no other custom exception types used at runtime that do not have similar documentation. All other exceptions indicate a program/logic error, not a recoverable state, and use built-in exception types.
@ajcvickers ajcvickers added the closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. label Jun 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ajcvickers ajcvickers

Labels
closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. type-bug
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
3 participants
@ajcvickers @rowanmiller @denisz1