Fix #268: New Rule: No Specs #271
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Avoid `-spec` attributes. | ||
|
|
||
| This rule is meant to be used on header files only. | ||
| Defining specs in public header files (especially those intended for inclusion via `-include_lib(...)`) |
There was a problem hiding this comment.
I prefer the term "typespec" instead of just "spec" but I'm not sure there's a set "rule"/"recommendation" for this.
There was a problem hiding this comment.
To me, typespec refers to the -type spec ;)
There was a problem hiding this comment.
Specification for functions seems to be the official term ™️
https://www.erlang.org/doc/reference_manual/typespec.html#specifications-for-functions
There was a problem hiding this comment.
But… we already used the word "spec" here: https://github.com/inaka/elvis_core/blob/main/doc_rules/elvis_style/no_spec_with_records.md
paulo-ferraz-oliveira
approved these changes
Feb 27, 2023
Co-authored-by: Paulo F. Oliveira <paulo.ferraz.oliveira@gmail.com>
Co-authored-by: Paulo F. Oliveira <paulo.ferraz.oliveira@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.