LUCENE-7858: checkJavadocLinks.py to mention common root causes of broken links

This commit is contained in:
Christine Poerschke 2017-06-02 10:40:53 +01:00
parent cccf97cae8
commit 445ceda01c
1 changed files with 4 additions and 1 deletions

View File

@ -266,7 +266,10 @@ def checkAll(dirName):
if __name__ == '__main__':
if checkAll(sys.argv[1]):
print()
print('Broken javadocs links were found!')
print('Broken javadocs links were found! Common root causes:')
# please feel free to add to this list
print('* A typo of some sort for manually created links.')
print('* Public methods referencing non-public classes in their signature.')
sys.exit(1)
sys.exit(0)