opam icon indicating copy to clipboard operation
opam copied to clipboard

lint W47: clarify empty description message

Open rjbou opened this issue 3 years ago • 2 comments
trafficstars

~Specify that descr section is empty instead of description~ remove descr note in order to deprecate it fix #4989

-warning 47: Synopsis (or description first line) should start with a capital and not end with a dot
+warning 47: Synopsis  should start with a capital and not end with a dot

rjbou avatar Feb 25 '22 16:02 rjbou

from dev meeting: We need to check synopsis & description usage. synopsis must not be empty, and description is optional. it's descr that is optional -> add a deprectaed message when encountered (in order to remove it)

rjbou avatar Mar 16 '22 15:03 rjbou

proposal: in this PR, we remove the descr reference, and in another, we deprecate and clean-up OpamFile.Descr usage

rjbou avatar Mar 16 '22 15:03 rjbou

This just needs:

  • Changes entry updating, as it got out of sync with the PR
  • An issue to be opened to track adding a new lint warning for missing synopsis

dra27 avatar Jan 23 '23 13:01 dra27

Thanks!

kit-ty-kate avatar Feb 14 '23 12:02 kit-ty-kate

The followup PR to restore the missing lint is at https://github.com/ocaml/opam/pull/5442

kit-ty-kate avatar Feb 14 '23 12:02 kit-ty-kate