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

Add Specific Errors To Documention #11

Closed
2 tasks done
DirectXMan12 opened this issue Dec 9, 2014 · 0 comments
Closed
2 tasks done

Add Specific Errors To Documention #11

DirectXMan12 opened this issue Dec 9, 2014 · 0 comments
Assignees
@DirectXMan12
Labels
documentation
Milestone
1.1.0

Comments

@DirectXMan12
Copy link
Member

We should add the specific errors that a method can throw to the documentation (since the RFC documents this). If supplementary errors can be thrown, just use document the SupplementaryError class.

  • low-level API documented
  • high-level API documented
@DirectXMan12 DirectXMan12 added this to the 1.1.0 milestone Dec 9, 2014
DirectXMan12 added a commit that referenced this issue Feb 10, 2015
@DirectXMan12
Low-Level: Document Specific Errors
35af55c 
Now that we have specific errors (found in `gssapi.raw.exceptions`),
we should document which errors can be thrown.

This commit does so for the low-level API.  In the case where no
errors were documented, the only error documented was the generic
GSSError, otherwise, GSSError was removed, and the specific listed
errors were added (except in the case where GSS_S_FAILURE is
specifically listed, in which case so is GSSError).

Note that non-RFC extensions did not have specific errors documented,
since they do not have a standardized list of specific errors.

Part of #11
DirectXMan12 added a commit that referenced this issue Feb 10, 2015
@DirectXMan12
High-Level: Document Specific Errors
d27eb81 
Now that we have specific errors (found in `gssapi.raw.exceptions`),
we should document which errors can be thrown.

This commit does so for the high-level API.

Closes #11
@DirectXMan12 DirectXMan12 mentioned this issue Feb 10, 2015
Merged
@DirectXMan12 DirectXMan12 self-assigned this Feb 10, 2015
DirectXMan12 added a commit that referenced this issue Feb 11, 2015
@DirectXMan12 @frozencemetery
Low-Level: Document Specific Errors
746052a 
Now that we have specific errors (found in `gssapi.raw.exceptions`),
we should document which errors can be thrown.

This commit does so for the low-level API.  In the case where no
errors were documented, the only error documented was the generic
GSSError, otherwise, GSSError was removed, and the specific listed
errors were added (except in the case where GSS_S_FAILURE is
specifically listed, in which case so is GSSError).

Note that non-RFC extensions did not have specific errors documented,
since they do not have a standardized list of specific errors.

Part of #11
This was referenced Aug 21, 2015
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DirectXMan12 DirectXMan12

Labels
documentation
Projects
None yet
Milestone
1.1.0
Development

No branches or pull requests
1 participant
@DirectXMan12