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

[pull] master from erlang:master #212

Merged
merged 3 commits into from
Feb 11, 2025
Merged

[pull] master from erlang:master #212

merged 3 commits into from
Feb 11, 2025

Conversation

pull[bot]
Copy link

@pull pull bot commented Feb 11, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Documentation:

  • Document the supervisor:which_children/1 function's availability since OTP 19345.

@pull pull bot added the ⤵️ pull label Feb 11, 2025
@pull pull bot merged commit ecc92ec into garazdawi:master Feb 11, 2025
Copy link

sourcery-ai bot commented Feb 11, 2025

Reviewer's Guide by Sourcery

This pull request integrates changes from the erlang:master branch. The main implementation is the addition of a documentation line in the supervisor module that embeds OTP version metadata, ensuring that the supervision tree's child specification function is annotated with the OTP version when it was introduced. Additionally, there is an update to the configuration file, likely to keep it in sync with the merges from master.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added OTP version metadata to supervisor documentation
  • Inserted a new doc attribute with OTP version metadata (OTP-19345) immediately after the call to which_children
  • Ensured that the documentation for the child specification and process is enhanced with versioning information
lib/stdlib/src/supervisor.erl
Updated configuration file
  • Modified erts/configure file, potentially for consistency with the merged changes from erlang:master
erts/configure

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants