3pp-mirror/public-apis
1
0
Fork 0
mirror of https://github.com/public-apis/public-apis.git synced 2025-05-11 08:06:46 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add build check for title ending with "API"

Browse source 
every entry in this project is an API, so specifying adds nothing
meaningful
This commit is contained in:
Dave Machado 2018-01-02 13:15:40 -05:00
parent 367de578e6
commit 8940786d0c
No known key found for this signature in database
GPG key ID: 948D4778D01A7B3F
2 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
build/validate_format.py
View file

@ -49,7 +49,7 @@ def check_format(filename):
for category, entries in sections.items():
if sorted(entries) != entries:
add_error(section_line_num[category], '{} section is not in alphabetical order'.format(category))
add_error(section_line_num[category], "{} section is not in alphabetical order".format(category))
# END Alphabetical Order
# START Check Entries
@ -64,6 +64,11 @@ def check_format(filename):
add_error(line_num, "each segment must start and end with exactly 1 space")
# END Global
segments = [seg.strip() for seg in segments]
# START Title
title = segments[index_title].upper()
if title.endswith(' API'):
add_error(line_num, 'Title should not contain "API"')
# END Title
# START Description
# first character should be capitalized
char = segments[index_desc][0]
@ -97,7 +102,7 @@ def check_format(filename):
def main():
num_args = len(sys.argv)
if num_args < 2:
print("No .md file passed")
print("No file passed (file should contain Markdown table syntax)")
sys.exit(1)
check_format(sys.argv[1])