YunoHost/package_linter
1
0
Fork 0
mirror of https://github.com/YunoHost/package_linter.git synced 2024-09-03 20:06:12 +02:00
Code Issues Projects Releases Packages Wiki Activity

No need to start description by is

Browse source
This commit is contained in:
Alexandre Aubin 2020-04-11 18:34:56 +02:00
parent 0e8e5ba043
commit e7c24466be
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
package_linter.py
View file

@ -581,11 +581,11 @@ class App():
# YEP 1.8 Publish test request # YEP 1.8 Publish test request
# YEP 1.9 Document app # YEP 1.9 Document app
if "description" in manifest: if "description" in manifest:
descr = manifest["description"] descr = manifest.get("description", "")
if isinstance(descr, dict): if isinstance(descr, dict):
descr = descr.get("en", None) descr = descr.get("en", "")
if descr is None or descr == "" or descr == manifest.get("name", None): if len(descr) < 5:
print_warning( print_warning(
"[YEP-1.9] You should write a good description of the app, " "[YEP-1.9] You should write a good description of the app, "
"at least in english (1 line is enough)." "at least in english (1 line is enough)."
@ -596,12 +596,14 @@ class App():
"[YEP-1.9] Please use a shorter description (or the rendering on the webadmin / app list will be messy ...). Just describe in consise terms what the app is / does." "[YEP-1.9] Please use a shorter description (or the rendering on the webadmin / app list will be messy ...). Just describe in consise terms what the app is / does."
) )
elif "for yunohost" in descr.lower(): elif "for yunohost" in descr.lower() :
print_warning( print_warning(
"[YEP-1.9] The 'description' should explain what the app actually does. " "[YEP-1.9] The 'description' should explain what the app actually does. "
"No need to say that it is 'for YunoHost' - this is a YunoHost app " "No need to say that it is 'for YunoHost' - this is a YunoHost app "
"so of course we know it is for YunoHost ;-)." "so of course we know it is for YunoHost ;-)."
) )
if descr.lower().startswith(manifest["id"].lower()) or descr.lower().startswith(manifest["name"].lower()):
print_warning("[YEP-1.9] Try to avoid starting the description by '$app is' ... explain what the app is / does directly !")
# TODO test a specific template in README.md # TODO test a specific template in README.md