Skip to content

Update Kernel.ParallelCompiler docs reflecting hard-deprecation changes #14821

@eksperimental

Description

@eksperimental

Elixir and Erlang/OTP versions

Elixir v1.19-rc1

Current behavior

In the Kernel.ParallelCompiler we can read:

It returns {:ok, modules, warnings} or {:error, errors, warnings} by default but we recommend using return_diagnostics: true so it returns diagnostics as maps as well as a map of compilation information.

but the warning now says:

warning: you must pass return_diagnostics: true when invoking Kernel.ParallelCompiler

The former is a suggestion, the latter is a requirement.

Expected behavior

Warnings and docs be consistent

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions