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.
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
Add
Enumerable#find_value
#14893Add
Enumerable#find_value
#14893Changes from 2 commits
9d50386
a5c3ddd
56cc782
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be of some benefit to have the method strictly typed rather than leaving the compiler to infer everything. We had a discussion in the Discord server and concluded it would mean having an overload specifically for a
nil
/no-default case, but I think that would be better overall:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a fan of explicit types, but this is still type inference. What benefit are you seeing here that I'm not seeing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find that the explicitness of method signatures are more useful even if there is no real difference between them. It's also clear what the return type of the method is as both I and another Crystal user initially misinterpreted the return type as being the value of the enumerable type (i.e.
T
). When taking into accountEnumerable#find
which has an identical signature, it makes sense to be explicit here to reduce confusion.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that it's more explicit, but I don't know if I agree that it reduces confusion. To my eyes, it just looks like a jumble of type placeholders.
Does the doc comment provide insufficient disambiguation between it and
find
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think type restrictions are always helpful as they document the expectations of input and ouput types. Even if it's a bit complicated to express.
IMO we should ideally always write down all type restrictions as part of the API documentation.
As a comment on the suggested format, different names
T -> V
andT -> U
are confusing. They're doing the same thing, so both proc types should use the same name for their output type.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My argument isn't against it being difficult to express. It's about it being more difficult to read.
The code as it currently exists in this branch is easier to read and aligns with existing conventions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion, public API methods should always have as many and as detaillled type restrictions as possible.
If we can type it, we should type it. This has not always happened in the past, and might always be the case in the future. But I'd prefer it that way.
I don't find it helpful to leave out relevant type information for the sake of readability.
Nobody needs to read the type restrictions if they don't care about them. But if you care about them, they should be available.
That being said, I'm happy to accept this PR without the additional type information. We can add it in a follow-up (or not).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we have type inference in Crystal, what purpose do type annotations (beyond those needed to satisfy the compiler) serve, if not clarity for the reader?
For the record, I am a fan of type annotations in Crystal. 😄 I use them most of the time when they improve clarity. But I think there's a point where they start providing negative value and I also think this is one of those times.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The purpose of type annotations is to provide information to the user. It supports the formal declaration of the API.
No annotations means less information, so it's less useful.
There might be a point where the types are too complex to express with the type grammar. But I don't think this is too much complexity:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that many other methods in
Enumerable
just use& : T ->
while some others use an explicitforall
... Maybe this whole thread is just circumstantial to the feature, and we could continue this discussion on a follow up normalization ofEnumerable
(and other) type signatures?That would allow us to avoid delay merging this PR any longer 🙂