Skip to content
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

gb_sets: group aliased functions in documentation #7568

Merged
merged 1 commit into from
Aug 18, 2023

Conversation

Maria-12648430
Copy link
Contributor

In gb_sets, the functions add_element/2, del_element/2 and is_element/2 are aliases for add/2, delete_any/2 and is_member/2 respectively, added for compatibility with sets and ordsets.

While add_element/2 and add/2 were grouped together into the same paragraph, del_element/2/delete_any/2 and is_element/2/is_member/2 were in distinct paragraphs (with duplicate content), giving the impression that there was some kind of difference between them.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 17, 2023

CT Test Results

       2 files       89 suites   40m 42s ⏱️
1 905 tests 1 657 ✔️ 248 💤 0
2 200 runs  1 942 ✔️ 258 💤 0

Results for commit 122883c.

♻️ 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

@bjorng bjorng added team:VM Assigned to OTP team VM enhancement documentation labels Aug 17, 2023
@bjorng
Copy link
Contributor

bjorng commented Aug 17, 2023

Thanks for the pull request. I suggest that you also group difference/2 and subtract/2.

@bjorng bjorng self-assigned this Aug 17, 2023
@Maria-12648430
Copy link
Contributor Author

Oops, I missed that one 😅

@Maria-12648430
Copy link
Contributor Author

Done.

Btw, while I'm at it: The docs for insert/2 and delete/2 rather laconically state that they assume that Elementis (not) present in Set1. Is it worth elaborating/rephrasing that an error will be thrown in those cases?

@bjorng bjorng added the testing currently being tested, tag is used by OTP internal CI label Aug 18, 2023
@bjorng
Copy link
Contributor

bjorng commented Aug 18, 2023

Is it worth elaborating/rephrasing that an error will be thrown in those cases?

In my opinion, no. I find the current description clear enough.

@bjorng bjorng merged commit 29bc5ec into erlang:master Aug 18, 2023
15 checks passed
@bjorng
Copy link
Contributor

bjorng commented Aug 18, 2023

Thanks for your pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement team:VM Assigned to OTP team VM testing currently being tested, tag is used by OTP internal CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants