saveourtool/diktat

False positive `KDOC_WITHOUT_RETURN_TAG` for functions returning `Unit` (implicit) or `Nothing` (explicit)

Open

#1 406 ouverte le 27 juin 2022

Voir sur GitHub
 (2 commentaires) (0 réactions) (1 assigné)Kotlin (40 forks)github user discovery
buggood first issue

Métriques du dépôt

Stars
 (571 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

DiKTat should require no @return tags in KDoc comments for expression-body functions with an implicit Unit or an explicit Nothing return types. In the below cases, a KDoc without any @return tag is sufficient:

/**
 * This function does nothing.
 */
fun f1() = Unit

/**
 * This function does nothing.
 */
fun f2() = kotlin.Unit

/**
 * This function fails immediately.
 */
fun fail1(): Nothing = TODO()

/**
 * This function fails immediately.
 */
fun fail2(): kotlin.Nothing = TODO()

Environment information

  • diktat version: 1.2.0
  • build tool (maven/gradle): Maven
  • how is diktat run (CLI, plugin, etc.): Maven plug-in
  • kotlin version: 1.7.0
  • operating system: Windows

Guide contributeur

Direction de recherche
Examinez l'implémentation de la règle KDOC WITHOUT RETURN TAG pour identifier pourquoi les types de retour Unit et Nothing déclenchent un faux positif. Vérifiez la logique qui détermine quand @return est requis et envisagez d'ajouter des exceptions pour Unit implicite et Nothing explicite.
Stack technique
kotlin
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Kotlin
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70