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

Resolve Duplicate Docs Warnings #180

Merged
merged 1 commit into from Sep 10, 2022

Conversation

jherdman
Copy link
Contributor

@jherdman jherdman commented Sep 2, 2021

Warnings were being issued regarding duplicate documentation
declarations. Here's an example:

warning: redefining @doc attribute previously set at line 27.

Please remove the duplicate docs. If instead you want to override a previously defined @doc, attach the @doc attribute to a function head (the function signature not followed by any do-block). For example:

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

  lib/exvcr/mock.ex:48: ExVCR.Mock.use_cassette/3

This change resolves these warnings by merging documentation and adding
examples that were already available in the README file.

Warnings were being issued regarding duplicate documentation
declarations. Here's an example:

```
warning: redefining @doc attribute previously set at line 27.

Please remove the duplicate docs. If instead you want to override a previously defined @doc, attach the @doc attribute to a function head (the function signature not followed by any do-block). For example:

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

  lib/exvcr/mock.ex:48: ExVCR.Mock.use_cassette/3
```

This change resolves these warnings by merging documentation and adding
examples that were already available in the README file.
@xn
Copy link

xn commented Jun 9, 2022

Is there any reason this can't be merged?

@parroty
Copy link
Owner

parroty commented Sep 10, 2022

Thank you for the follow up. Sorry being late to respond 🙇 . I was overlooking this item.

@parroty parroty merged commit 5201278 into parroty:master Sep 10, 2022
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.

None yet

3 participants