Fix KerberosTicket documentation and minor cleanups - #2
Open
Montana wants to merge 1 commit into
Open
Conversation
The module-level usage example constructed KerberosTicket() without the required ticket_file positional argument, so copying the documented example raises TypeError. Add ticket_file to the example and mention it in the class docstring. Also remove an f-string prefix from a string with no placeholders and fix an 'or now' -> 'or not' typo in a comment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The module-level usage example constructs
KerberosTicket()without the requiredticket_filepositional argument, so copying the documented example raisesTypeError. This PR addsticket_filetothe example and mentions it in the class docstring.
It also removes an f-string prefix from a string with no placeholders and fixes an 'or now' -> 'or not' typo in a comment.
Good luck at Stanford!
Cheers,
Michael