Skip to content

Commit e85497c

Browse files
author
Rarylson Freitas
committed
Typo (strict_mode instead of strict) in README.rst
`strict` is the param, `strict_mode` is the inner attribute of the `SSHKey` implementation.
1 parent 8da9bf9 commit e85497c

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Usage:
3030
ssh = SSHKey("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAYQCxO38tKAJXIs9ivPxt7AY"
3131
"dfybgtAR1ow3Qkb9GPQ6wkFHQqcFDe6faKCxH6iDRteo4D8L8B"
3232
"xwzN42uZSB0nfmjkIxFTcEU3mFSXEbWByg78aoddMrAAjatyrh"
33-
"H1pON6P0= ojarva@ojar-laptop", strict_mode=True)
33+
"H1pON6P0= ojarva@ojar-laptop", strict=True)
3434
try:
3535
ssh.parse()
3636
except InvalidKeyError as err:
@@ -51,9 +51,9 @@ Usage:
5151
Options
5252
-------
5353

54-
Set options in constructor as a keywords (i.e., `SSHKey(None, strict_mode=False)`)
54+
Set options in constructor as a keywords (i.e., `SSHKey(None, strict=False)`)
5555

56-
- strict_mode: defaults to True. Disallows keys OpenSSH's ssh-keygen refuses to create. For instance, this includes DSA keys where length != 1024 bits and RSA keys shorter than 1024-bit. If set to False, tries to allow all keys OpenSSH accepts, including highly insecure 1-bit DSA keys.
56+
- strict: defaults to True. Disallows keys OpenSSH's ssh-keygen refuses to create. For instance, this includes DSA keys where length != 1024 bits and RSA keys shorter than 1024-bit. If set to False, tries to allow all keys OpenSSH accepts, including highly insecure 1-bit DSA keys.
5757
- skip_option_parsing: if set to True, options string is not parsed (ssh.options_raw is populated, but ssh.options is not).
5858
- disallow_options: if set to True, options are not allowed and it will raise an
5959
InvalidOptionsError.

0 commit comments

Comments
 (0)