Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nagging message on each pin: "Synopsis (or description first line) should start with a capital" #4686

Open
RalfJung opened this issue May 28, 2021 · 5 comments

Comments

@RalfJung
Copy link

We have a package with the following synopsis:

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?

@kit-ty-kate
Copy link
Member

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.

@RalfJung
Copy link
Author

I mean I guess we could work around it, but I find this kind of micro-management-warning to be somewhat obtrusive.

@dra27
Copy link
Member

dra27 commented Jun 7, 2021

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).

@dra27
Copy link
Member

dra27 commented Jun 7, 2021

However, there is a bigger question of whether linting on pinning is strictly useful.

@RalfJung
Copy link
Author

RalfJung commented Jun 7, 2021

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.

@dra27 dra27 added this to To do in Opam 2.2.0 via automation Jul 2, 2021
@rjbou rjbou moved this from To do to In progress in Opam 2.2.0 Feb 11, 2022
@dra27 dra27 removed this from In progress in Opam 2.2.0 May 17, 2022
@dra27 dra27 added this to To do in Opam 2.3 via automation May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Opam 2.3
  
To do
Development

No branches or pull requests

4 participants