mirror of https://github.com/apache/lucene.git
LUCENE-7858: checkJavadocLinks.py to mention common root causes of broken links
This commit is contained in:
parent
cccf97cae8
commit
445ceda01c
|
@ -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)
|
||||
|
||||
|
|
Loading…
Reference in New Issue