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

Polish documentation for the sofs module #9613

Merged
merged 1 commit into from
Mar 21, 2025

Conversation

bjorng
Copy link
Contributor

@bjorng bjorng commented Mar 20, 2025

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, do some other minor clean ups.

@bjorng bjorng added team:VM Assigned to OTP team VM enhancement testing currently being tested, tag is used by OTP internal CI labels Mar 20, 2025
@bjorng bjorng requested review from garazdawi and lucioleKi March 20, 2025 06:27
@bjorng bjorng self-assigned this Mar 20, 2025
Copy link
Contributor

github-actions bot commented Mar 20, 2025

CT Test Results

    2 files     97 suites   1h 9m 16s ⏱️
2 202 tests 2 155 ✅ 47 💤 0 ❌
2 571 runs  2 522 ✅ 49 💤 0 ❌

Results for commit 90656ed.

♻️ 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 force-pushed the bjorn/stdlib/polish-sofs-documentation branch 2 times, most recently from 7c2f443 to 48054ff Compare March 20, 2025 07:29
lucioleKi
lucioleKi previously approved these changes Mar 20, 2025
Copy link
Contributor

@garazdawi garazdawi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Maybe after this I will finally be able to understand what sofs does!

@bjorng bjorng force-pushed the bjorn/stdlib/polish-sofs-documentation branch from 48054ff to 90656ed Compare March 21, 2025 04:39
@bjorng bjorng requested review from garazdawi and lucioleKi March 21, 2025 04:41
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, do some other minor clean ups.
@bjorng bjorng force-pushed the bjorn/stdlib/polish-sofs-documentation branch from 90656ed to 3836a12 Compare March 21, 2025 11:25
@bjorng bjorng requested a review from garazdawi March 21, 2025 11:26
@bjorng bjorng merged commit 8c88e0e into erlang:master Mar 21, 2025
22 checks passed
@bjorng bjorng deleted the bjorn/stdlib/polish-sofs-documentation branch March 21, 2025 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants