More docs cleanup #3942
Merged
More docs cleanup #3942
+1,142
−971
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mverzilli
requested changes
Jan 28, 2017
| # this invokes `includes?`. For example: | ||
| # An enum automatically defines question methods for each member, using | ||
| # `String#underscore` for the method name. | ||
| # * If the case of regular enums, this compares by equality (`==`). |
There was a problem hiding this comment.
Should be "In the case of regular enums [...]"
| @@ -1,6 +1,6 @@ | |||
| require "./openssl/lib_ssl" | |||
|
|
|||
| # # OpenSSL Integration | |||
| # ## Integration | |||
There was a problem hiding this comment.
Why remove the OpenSSL here? It might be a bit redundant, but I think it's anyway more clear in this case to leave OpenSSL Integration
| @@ -16,13 +16,13 @@ require "base64" | |||
| # ``` | |||
| # | |||
| # The implementation follows the | |||
| # [libsodium sysrandom](https://github.com/jedisct1/libsodium/blob/6fad3644b53021fb377ca1207fa6e1ac96d0b131/src/libsodium/randombytes/sysrandom/randombytes_sysrandom.c) | |||
| # [libsodium sysrandom](https://github.com/jedisct1/libsodium/blob/master/src/libsodium/randombytes/sysrandom/randombytes_sysrandom.c) | |||
There was a problem hiding this comment.
Isn't it better to point this to a specific commit as it used to? master may break, for example if they rename or move the file.
There was a problem hiding this comment.
You're right, had a bad feeling about that too, I'll change it back.
mverzilli
approved these changes
Jan 28, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains 2nd batch of docs cleanup:
ClassNames