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

Fixes OPENSSL_LIBRARY_VERSION description on documentation #559

Merged
merged 2 commits into from Nov 23, 2022

Conversation

hbontempo-br
Copy link
Contributor

Adds back missing constant description on the documentation

Currently:

After fix:

#if !defined(LIBRESSL_VERSION_NUMBER) && OPENSSL_VERSION_NUMBER >= 0x10100000
rb_define_const(mOSSL, "OPENSSL_LIBRARY_VERSION", rb_str_new2(OpenSSL_version(OPENSSL_VERSION)));
const char *ssl_version = OpenSSL_version(OPENSSL_VERSION);
Copy link
Member

Choose a reason for hiding this comment

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

openssl gem supports older Ruby versions, so we can't use C99 feature (declaration after statements) yet.

Would rdoc be happy if we simply move the doc comment inside the #if block?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks!
Did what you suggested.

@rhenium rhenium merged commit 728dc91 into ruby:master Nov 23, 2022
@rhenium
Copy link
Member

rhenium commented Nov 23, 2022

Thank you!

matzbot pushed a commit to ruby/ruby that referenced this pull request Dec 13, 2022
documentation
(ruby/openssl#559)

Adds back missing constant description on the documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants