Add docstrings to some of the distributions #15
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
alex-lew
reviewed
Mar 6, 2021
| @@ -1,5 +1,26 @@ | |||
| import StringDistances: DamerauLevenshtein, evaluate | |||
|
|
|||
| """ | |||
| word_with_typos::String ~ AddTypos(word::String, max_typos=nothing) | |||
There was a problem hiding this comment.
I am slightly concerned that this style of documentation implies that we support this syntax, when in fact I don't believe PClean's parser can handle type annotations on the LHS of a ~. We could just fix this in PClean (and probably should, eventually)—or we could find another way to communicate the return type?
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.
No description provided.