Add linting for public documentation #45
Merged
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
andresuribe87
requested review from
mistermoe and
nitro-neal
as code owners
nitro-neal
reviewed
Sep 27, 2023
| @@ -1,3 +1,6 @@ | |||
| /** | |||
| * A utility object for Base58 encoding and decoding. | |||
| */ | |||
| public object Base58Btc { | |||
| private val ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz" | |||
There was a problem hiding this comment.
@nitro-neal, there's more context on the crypto branch here
Currently, Base58Btc is used for did:key
nitro-neal
reviewed
Sep 27, 2023
| @@ -1,3 +1,6 @@ | |||
| /** | |||
| * A utility object for Base58 encoding and decoding. | |||
| */ | |||
| public object Base58Btc { | |||
| private val ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz" | |||
There was a problem hiding this comment.
No idea lol. It was already in there.
nitro-neal
reviewed
Sep 27, 2023
Co-authored-by: nitro-neal <[email protected]>
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.
Overview
This PR modifies the detekt configuration to check undocumented public functions and classes. All instances that were offending have been fixed as well with the help of Chad.
Description
See above.
How Has This Been Tested?
No functional changes.