search

sindresorhus / awesome-lint

Linter for Awesome lists
MIT License
601 stars 57 forks source link

Rule Idea: item description should not be the same like item name #125

Open wernerkrauss opened 3 years ago

wernerkrauss commented 3 years ago

This should avoid something like:

Some Item Name - Some Item Name.

sindresorhus commented 3 years ago

Good idea. Could we take it as far as saying that the description should not even contain the title?

wernerkrauss commented 3 years ago

Could we take it as far as saying that the description should not even contain the title?

Phew, could there be valid cases where the title can be in the description? At least it should not start with the title. So this is invalid:

Some Item Name - Some Item Name is totally awesome.

In a PR I received this today:

It has "SSPy" in the description and I tend to accept it. OTOH one could rewrite it like "This module has no limit" to avoid the title in the description.

sindresorhus commented 3 years ago

Ok, let's do "description cannot start with".