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

Fix compilation warning on Elixir 1.11 #244

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

axelson
Copy link
Contributor

@axelson axelson commented Mar 7, 2021

Here's an example of the warning:

==> slack
Compiling 10 files (.ex)
warning: redefining @doc attribute previously set at line 88.

Please remove the duplicate docs. If instead you want to override a previously defined @doc, attach the @doc attribute to a function head:

    @doc """
    new docs
    """
    def lookup_channel_name(...)

  lib/slack/lookups.ex:95: Slack.Lookups.lookup_channel_name/2

Compilation failed due to warnings while using the --warnings-as-errors option

On previous versions the initial @doc was silently ignored:

iex(1)> h Slack.Lookups.lookup_channel_name

                   def lookup_channel_name(channel_id, slack)

Turns a Slack private channel ID ("G…") into a string in the format
"#CHANNEL_NAME".

This change is backwards compatible with older elixir versions.

Here's an example of the warning:
```
==> slack
Compiling 10 files (.ex)
warning: redefining @doc attribute previously set at line 88.

Please remove the duplicate docs. If instead you want to override a previously defined @doc, attach the @doc attribute to a function head:

    @doc """
    new docs
    """
    def lookup_channel_name(...)

  lib/slack/lookups.ex:95: Slack.Lookups.lookup_channel_name/2

Compilation failed due to warnings while using the --warnings-as-errors option
```

On previous versions the initial `@doc` was silently ignored:
```
iex(1)> h Slack.Lookups.lookup_channel_name

                   def lookup_channel_name(channel_id, slack)

Turns a Slack private channel ID ("G…") into a string in the format
"#CHANNEL_NAME".
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant