Merge remote-tracking branch 'myk002/myk_no_test_docstrings' into develop

develop
lethosor 2021-03-10 00:44:23 -05:00
commit 890fd5c746
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
3 changed files with 5 additions and 2 deletions

@ -36,6 +36,9 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
## Documentation ## Documentation
- Added more client library implementations to the `remote interface docs <remote-client-libs>` - Added more client library implementations to the `remote interface docs <remote-client-libs>`
## Internals
- Lua test files are no longer required to start with standard script documentation (since they aren't runnable scripts)
# 0.47.05-r1 # 0.47.05-r1
## Fixes ## Fixes

@ -317,7 +317,7 @@ static void listScripts(PluginManager *plug_mgr, std::map<string,string> &pset,
pset[key] = help; pset[key] = help;
} }
} }
else if (all && !files[i].empty() && files[i][0] != '.' && files[i] != "internal") else if (all && !files[i].empty() && files[i][0] != '.' && files[i] != "internal" && files[i] != "test")
{ {
listScripts(plug_mgr, pset, path+files[i]+"/", all, prefix+files[i]+"/"); listScripts(plug_mgr, pset, path+files[i]+"/", all, prefix+files[i]+"/");
} }

@ -81,7 +81,7 @@ def check_file(fname):
def main(): def main():
"""Check that all DFHack scripts include documentation""" """Check that all DFHack scripts include documentation"""
err = 0 err = 0
exclude = set(['internal']) exclude = set(['internal', 'test'])
for root, dirs, files in os.walk(SCRIPT_PATH, topdown=True): for root, dirs, files in os.walk(SCRIPT_PATH, topdown=True):
dirs[:] = [d for d in dirs if d not in exclude] dirs[:] = [d for d in dirs if d not in exclude]
for f in files: for f in files: