Skip to content

Commit

Permalink
more grammatical changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Kierst01 committed Jan 27, 2024
1 parent 65f8dd8 commit bc023a0
Showing 1 changed file with 15 additions and 17 deletions.
32 changes: 15 additions & 17 deletions docs/example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Almost there, but he really want a 'Strong' password.\n",
"Almost there, but he really wants a 'Strong' password.\n",
"\n",
"***Note**: A good password contains at least 8 characters and at least two capital letters, numbers or special characters in total.*"
]
Expand Down Expand Up @@ -125,7 +125,7 @@
"source": [
"### Generate Password\n",
"\n",
"The `generate_password` function allows users to create a secure, customized password. It has three optional arguments. The first argument, length, corresponds to the desired length of the password given as an integer. Its minimum and default length is 12 and it's maximum is 100. The second argument is include_symbols while the third argument is include_numbers. They both take a boolean value, indicating whether special characters and numbers should be included in the generated password."
"The `generate_password` function allows users to create a secure, customized password. It has three optional arguments. The first argument, `length`, corresponds to the desired length of the password given as an integer. Its minimum and default length is 12 and it's maximum is 100. The second argument is `include_symbols` while the third argument is `include_numbers`. They both take a boolean value, indicating whether special characters and numbers should be included in the generated password."
]
},
{
Expand All @@ -134,9 +134,7 @@
"source": [
"#### First try: default settings\n",
"\n",
"To start out, Bob creates a password with the default settings. \n",
"\n",
"***Note**: This returns a password of length 12, with at least one uppercase letter, number and symbol.*"
"To start out, Bob creates a password with the default settings. "
]
},
{
Expand Down Expand Up @@ -165,14 +163,16 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"***Note**: This returns a password of length 12, with at least one uppercase letter, number and symbol.*\n",
"\n",
"#### Going for Length"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Intrigued, Bob decides to generate a much longer password, setting the `length` to its maximum, 100 characters."
"Intrigued, Bob decides to generate a much longer password, setting the `length` to its maximum: 100 characters."
]
},
{
Expand Down Expand Up @@ -253,7 +253,7 @@
"source": [
"#### First try: default settings\n",
"\n",
"Bob realizes that he needs to store his new password on his computer. However, he is worried that he might be hacked again so he decides to use the `Encrypt_Password` function. He tries the default setting first."
"Bob realizes that he needs to store his new password on his computer. However, he is worried that he might be hacked again so he decides to use the `encrypt_password` function. He tries the default setting first."
]
},
{
Expand Down Expand Up @@ -281,9 +281,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"What he didn’t know is that by not providing a random_seed argument, the default seed of 123 is used. \n",
"\n",
"***Note**: The random seed argument controls the shuffled character mapping.*"
"***Note**: The random seed argument controls the shuffled character mapping, its default is 123.*"
]
},
{
Expand All @@ -292,7 +290,7 @@
"source": [
"#### Going for a customized seed\n",
"\n",
"Then Bob thought it might be better to customize the seed, so he chose a random number he likes (this should not be a lucky number, your date of birth or anything that others can easily guess). This means that he needs to store the seed and the encrypted password in two different places, but as long as it is a unique seed, the encrypted password is safe. Bob uses the seed 42428 on his next try."
"Bob realises that the only way to keep his password safe is to customize the seed, so he chooses a random number, avoiding his date of birth or anything that others could easily guess. This means that he needs to store the seed and the encrypted password in two different places. Bob encrypts the password using the seed 42428."
]
},
{
Expand All @@ -319,12 +317,10 @@
"metadata": {},
"source": [
"### Decrypt a Password\n",
"The `decrypt_password` function decrypts a message that has previously been encrypted with the `encrypt_password` function. It uses the same seed that has been used for the `encrypt_password`. It takes two arguments, the first `encrypted_message` is the encrypted password passed in as a string, the second `random_seed` is the seed used for the encryption passed in as an integer value.\n",
"The `decrypt_password` function decrypts a password that has previously been encrypted with the `encrypt_password` function. It requires the same seed that was used in the `encrypt_password`. It takes two arguments, the first `encrypted_message` is the encrypted password passed in as a string. The `random_seed` argument is the seed that was used to encrypt the password, passed in as an integer value.\n",
"\n",
"#### First try: default setting\n",
"The next time Bob tries to log in to Facebook, he can't remember his password. Bob knows where he saved his encrypted password on his computer, but he cannot find the seed,so he tries to decrypt his encrypted password with the default settings.\n",
"\n",
"***Note**: if no random seed argument is given, the default of 123 will be used.*"
"The next time Bob tries to log in to Facebook, he can't remember his password. Bob knows where he saved his encrypted password on his computer, but he cannot find the seed, so he tries to decrypt his encrypted password with the default settings."
]
},
{
Expand Down Expand Up @@ -352,8 +348,10 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"***Note**: if no random seed argument is given, the default of 123 will be used.*\n",
"\n",
"#### Customized Seed\n",
"As we can see, that does not look like his original password. So Bob has to search his computer to find the seed he used. Fortunately, he finds it and tries to decrypt his password again."
"Ah, that does not look like his original password! Bob has to search through his notebook to find the seed he used for the encryption. Fortunately, he finds it and tries to decrypt his password again."
]
},
{
Expand Down Expand Up @@ -389,7 +387,7 @@
"source": [
"### Final remarks\n",
"\n",
"We hope you found these examples informative and learned through Bob's password mistakes. If anything remains unclear, we suggest reviewing the function documentation. "
"We hope you found these examples informative and learned through Bob's password mistakes. If anything remains unclear, we suggest reviewing the function documentation or creating an issue in our repository and we will get back to you."
]
}
],
Expand Down

0 comments on commit bc023a0

Please sign in to comment.