Improve Enum.with_index/2 docs
#13671
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
- fixes broken language in top-level description - unifies the snippet syntax to apply to the `offset` argument - previously, the argument name was surrounded by backticks in the first example, while the second example had the type surrounded in backticks
josevalim
reviewed
Jun 16, 2024
lib/elixir/lib/enum.ex
Outdated
| @@ -3847,14 +3847,12 @@ defmodule Enum do | |||
|
|
|||
| @doc """ | |||
| Returns the `enumerable` with each element wrapped in a tuple | |||
| alongside its index or according to a given function. | |||
| alongside its index. | |||
There was a problem hiding this comment.
We should still mention the function in the summary (first line). :)
josevalim
reviewed
Jul 2, 2024
|
💚 💙 💜 💛 ❤️ |
sabiwara
reviewed
Jul 3, 2024
Comment on lines
+3852
to
+3855
| If an `offset` integer is given, it will index from the given offset instead of from | ||
| zero. | ||
|
|
||
| If a `function` is given, it will index by invoking the function for each | ||
| If an `offset` function is given, it will index by invoking the function for each |
There was a problem hiding this comment.
Given that the name of the documented arg is fun_or_offset, this feels a bit confusing (especially since the function is not an offset)
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.
offsetargument