jeremyjh/dialyxir

Add explanations for warnings with default/missing explanations.

Open

#179 opened on Jun 8, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Elixir (159 forks)batch import
help wanted

Repository metrics

Stars
 (1,795 stars)
PR merge metrics
 (Avg merge 122d 13h) (1 merged PR in 30d)

Description

  • Dialyxir.Warnings.AppCall
  • Dialyxir.Warnings.Apply
  • Dialyxir.Warnings.BinaryConstruction
  • Dialyxir.Warnings.Call
  • Dialyxir.Warnings.CallToMissingFunction
  • Dialyxir.Warnings.CallWithOpaque
  • Dialyxir.Warnings.CallWithoutOpaque
  • Dialyxir.Warnings.CallbackArgumentTypeMismatch
  • Dialyxir.Warnings.CallbackInfoMissing
  • Dialyxir.Warnings.CallbackMissing
  • Dialyxir.Warnings.CallbackSpecArgumentTypeMismatch
  • Dialyxir.Warnings.CallbackSpecTypeMismatch
  • Dialyxir.Warnings.CallbackTypeMismatch
  • Dialyxir.Warnings.ContractDiff
  • Dialyxir.Warnings.ContractSubtype
  • Dialyxir.Warnings.ContractSupertype
  • Dialyxir.Warnings.ContractWithOpaque
  • Dialyxir.Warnings.ExactEquality
  • Dialyxir.Warnings.ExtraRange
  • Dialyxir.Warnings.FuncionApplicationArguments
  • Dialyxir.Warnings.FunctionApplicationNoFunction
  • Dialyxir.Warnings.GuardFail
  • Dialyxir.Warnings.GuardFailPattern
  • Dialyxir.Warnings.ImproperListConstruction
  • Dialyxir.Warnings.InvalidContract
  • Dialyxir.Warnings.MissingRange
  • Dialyxir.Warnings.NegativeGuardFail
  • Dialyxir.Warnings.NoReturn
  • Dialyxir.Warnings.OpaqueGuard
  • Dialyxir.Warnings.OpaqueEquality
  • Dialyxir.Warnings.OpaqueMatch
  • Dialyxir.Warnings.OpaqueNonequality
  • Dialyxir.Warnings.OpaqueTypeTest
  • Dialyxir.Warnings.OverlappingContract
  • Dialyxir.Warnings.PatternMatch
  • Dialyxir.Warnings.PatternMatchCovered
  • Dialyxir.Warnings.RaceCondition
  • Dialyxir.Warnings.RecordConstruction (likely not possible)
  • Dialyxir.Warnings.RecordMatching (likely not possible)
  • Dialyxir.Warnings.UnknownBehaviour
  • Dialyxir.Warnings.UnknownFunction
  • Dialyxir.Warnings.UnknownType
  • Dialyxir.Warnings.UnmatchedReturn
  • Dialyxir.Warnings.UnusedFunction

Contributor guide

Research direction
Review the existing warning modules that have explanations (e.g., Apply, Call) to understand the format and pattern, then add explanations for the unchecked warnings following the same structure.
Tech stack
elixir
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ElixirGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70