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

Fix typos in documentation. #7038

Closed
wants to merge 1 commit into from
Closed

Conversation

parasssh
Copy link
Contributor

CLA: trivial

Checklist
  • documentation is added or updated

@@ -25,7 +25,7 @@ The message to sign or verify must be passed using the one-shot
EVP_DigestSign() and EVP_DigestVerify() functions.

When calling EVP_DigestSignInit() or EVP_DigestVerifyInit(), the
digest parameter B<MUST> be set to B<NULL>.
digest B<type> parameter B<MUST> be set to B<NULL>.
Copy link
Member

Choose a reason for hiding this comment

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

I am not a native English speaker, but it seems if you want to address the parameter's name, place the name after the word 'parameter' sounds common - something like 'the digest parameter type MUST be set to NULL'.

Let's wait for others' opinions...

Copy link
Member

Choose a reason for hiding this comment

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

Not a native speaker either, but having seen both forms... Anyway, we have an actual English speaker that has approved this, I suspect we can see that as an "ok" sign 😃

@t-j-h
Copy link
Member

t-j-h commented Aug 23, 2018

If one of @InfoHunter or @levitte can pick this up and fixup the CLA: trivial position in the commit message (this is trivial and we have a clear indicator) then this is good to go in.

@t-j-h t-j-h added the approval: done This pull request has the required number of approvals label Aug 23, 2018
levitte pushed a commit that referenced this pull request Aug 23, 2018
CLA: trivial

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #7038)
@parasssh
Copy link
Contributor Author

@t-j-h , just so I know for the future, where should the CLA: trivial be in the commit message? I added it after the commit message separated by a blank line.

@levitte
Copy link
Member

levitte commented Aug 23, 2018

Merged.

fa332bb Fix typos in documentation.

Thanks!
(I made a quick attempt to cherry pick this to 1.1.0, but it didn't come out clean...)

@levitte levitte closed this Aug 23, 2018
@t-j-h
Copy link
Member

t-j-h commented Aug 23, 2018

@parasssh it is in the right place - was jumping between two PRs ... this one is good to go.
Thanks for the contribution!

It would be good to get a CLA on file for future contributions.

@levitte
Copy link
Member

levitte commented Aug 23, 2018

@parasssh, your placement of CLA: trivial was exactly right.

@parasssh
Copy link
Contributor Author

@t-j-h I already have a approved CLA on file as of Aug 20, 2018. But I thought this PR is still trivial.

@t-j-h
Copy link
Member

t-j-h commented Aug 23, 2018

Ahh. Excellent. I think where we have a CLA on file there is no need to mark a PR as trivial.

@InfoHunter
Copy link
Member

InfoHunter commented Aug 23, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approval: done This pull request has the required number of approvals
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants