Add Scaladoc for forProduct methods
#424
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
jcazevedo
approved these changes
Oct 9, 2018
|
|
||
| [2..22#final def forProduct1[B, [#A0#]]([#keyA0: String#])(f: ([#A0#]) => B)(implicit | ||
| [2..22# | ||
| /** |
There was a problem hiding this comment.
Nitpick: Can you move this to the line above and add an extra line before the [2..22#...? Just so that the methods only have a blank line between them in the generated code. The same thing applies for ProductWriters.
There was a problem hiding this comment.
Sure, fixed in 3076681.
| /** | ||
| * Builds a `ConfigReader` for an object created from the values of 1 keys. | ||
| * | ||
| * @param f the function converting the tuple of values to the target object |
There was a problem hiding this comment.
Nitpick: I may be wrong, but I don't think it's a tuple so much as an argument list. Were it a tuple, it'd have to be written as f: ((A0, A1)) => B
I suggest wording it as @param f the function constructing the target object from the read config values
There was a problem hiding this comment.
Indeed, they're not tuples. Corrected it in 766a323.
leifwickland
approved these changes
Oct 10, 2018
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.
Adds Scaladoc for the new methods so that basic documentation is available for them. Even though it was possible to generate the
@paramentries for thekeyNparameters, I opted not to do that since I think that it would actually make the Scaladoc pages less readable.