You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
synopsis: "std++ is an extended \"Standard Library\" for Coq"
Here, std++ is the name of the project, and it is to be written lower-case no matter where it appears in the sentence.
Yet, each time I opam pin this package, opam complains:
warning 47: Synopsis (or description first line) should start with a capital and not end with a dot
This complaint makes no sense as it asks me to mis-spell the name of the project. Is there any way to silence this false positive warning?
The text was updated successfully, but these errors were encountered:
In this particular case, why not simply rephrase it as An extended \"Standard Library\" for Coq, as std++ is already present where this is printed so this seems redundant.
I believe the warning is here to encourage people to avoid redundant wording like this. Though it can be flawed and annoying in some cases I find it mostly useful.
I agree with @kit-ty-kate - the lint warning is not asking for the package name to be misspelled, it's asking for a sentence complying with two requirements (well, technically the . bit is wrong - what it really means is that the sentence should end with . because one is inferred as present, but that's for another day).
So if want to keep the requirement "must start with a capital letter", then I think it would be helpful to give an example or otherwise indicate that this is not meant to be a sentence -- the alternative of using An extended "Standard Library" for Coq never occurred to me, as that is not a proper sentence.
We have a package with the following synopsis:
Here,
std++
is the name of the project, and it is to be written lower-case no matter where it appears in the sentence.Yet, each time I
opam pin
this package, opam complains:This complaint makes no sense as it asks me to mis-spell the name of the project. Is there any way to silence this false positive warning?
The text was updated successfully, but these errors were encountered: