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.

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

README.md Sentence structure improvement #103

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Script47
Copy link

@Script47 Script47 commented Sep 7, 2017

Fixed the sentence structure to make it easier to read.

Fixed the sentence structure to make it easier to read.
Copy link
Author

@Script47 Script47 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More improvements.

@@ -49,7 +49,7 @@ Another algorithm name is supported:
````
This will use the strongest algorithm available to PHP at the current time. Presently, this is the same as specifying `PASSWORD_BCRYPT`. But in future versions of PHP, it may be updated to use a stronger algorithm if one is introduced. It can also be changed if a problem is identified with the BCRYPT algorithm. Note that if you use this option, you are **strongly** encouraged to store it in a `VARCHAR(255)` column to avoid truncation issues if a future algorithm increases the length of the generated hash.

It is very important that you should check the return value of `password_hash` prior to storing it, because `false` or `null` may be returned if it encountered an error.
It is very important that you check the return value of `password_hash` prior to storing it, because `false` or `null` may be returned if it encounters any errors.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it encountered an error - the original text was already correct

@Script47
Copy link
Author

Script47 commented Sep 7, 2017

Definitely not, read how hard it is to say the original sentence:

It is very important that you should check the return value of password_hash prior to storing it, because false or null may be returned if it encountered an error.

You could possibly get away with the end change that I made but the should should not be be there. Compared to the sentence I proposed:

It is very important that you check the return value of password_hash prior to storing it, because false or null may be returned if it encountered an error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants