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

Complain about dummy/placeholder messages in the doc/ folder

Browse source
This commit is contained in:
Alexandre Aubin 2023-02-20 19:34:13 +01:00
parent 1b4f99575e
commit f0b1c81a9a
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
package_linter.py
View file

@ -611,7 +611,7 @@ class App(TestSuite):
@test() @test()
def disclaimer_wording(app): def disclaimer_wording_or_placeholder(app):
if os.path.exists(app.path + "/doc"): if os.path.exists(app.path + "/doc"):
if ( if (
os.system( os.system(
@ -623,6 +623,17 @@ class App(TestSuite):
yield Info( yield Info(
"In DISCLAIMER.md: 'Any known limitations [...] such as' and 'Other infos [...] such as' are supposed to be placeholder sentences meant to explain to packagers what is the expected content, but is not an appropriate wording for end users :/" "In DISCLAIMER.md: 'Any known limitations [...] such as' and 'Other infos [...] such as' are supposed to be placeholder sentences meant to explain to packagers what is the expected content, but is not an appropriate wording for end users :/"
) )
if (
os.system(
r"grep -nr -q 'This is a dummy\|Ceci est une fausse' %s/doc/"
% app.path
)
== 0
):
yield Warning(
"The doc/ folder seems to still contain some dummy, placeholder messages in the .md markdown files. If those files are not useful in the context of your app, simply remove them."
)
@test() @test()
def change_url_script(app): def change_url_script(app):