Polish documentation for the lists module #9464
Open
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
bjorng
added
team:VM
CT Test Results 2 files 97 suites 1h 10m 13s ⏱️ Results for commit 6cc8f7d. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
garazdawi
reviewed
Feb 19, 2025
lib/stdlib/src/lists.erl
Outdated
|
|
||
| _Examples:_ | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Consistency is good, but I don't think there is any technical reason to have erlang. Both ExDoc and shell_docs_test assume that if no language is given, it is erlang.
garazdawi
previously approved these changes
Feb 19, 2025
lib/stdlib/src/lists.erl
Outdated
| Returns a new list `List3` that is a copy of `List1`, subjected to the following | ||
| procedure: for each element in `List2`, its first occurrence in `List1` is | ||
| deleted. | ||
|
|
lib/stdlib/src/lists.erl
Outdated
| -doc "Returns a list containing the sorted elements of `List1`.". | ||
| ``` | ||
| > lists:sort([4,3,9]). | ||
| [3,4,9] |
There was a problem hiding this comment.
Should we include a non-integer example?
bjorng
force-pushed
the
bjorn/stdlib/lists-documentation
branch
2 times, most recently
from
4656cd7 to
2bb85e8
Compare
garazdawi
previously approved these changes
Feb 20, 2025
bjorng
changed the title
Ensure that the first paragraph describing each function makes sense by itself when shown in the Summary part of the documentation. Add examples to functions lacking examples. While at it, also remove comments for documented functions, and remove out-commented code, and do some other minor clean ups.
bjorng
force-pushed
the
bjorn/stdlib/lists-documentation
branch
from
2455cff to
6cc8f7d
Compare
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.
Ensure that the first paragraph describing each function makes sense by itself when shown in the Summary part of the documentation.
Add examples to functions lacking examples.
While at it, also remove comments for documented functions, and remove out-commented code, and do some other minor clean ups.