aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2026-02-18 12:34:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: handle "added": "version" and "deprecated": "version" from schemas.

Browse Source 
This means we will document deprecations and additions, rather than just
pretending they've always been that way!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
2023-01-10 10:21:01 +10:30
parent 3f8199bbfd
commit b2148d0eab
98 changed files with 123 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
tools/fromschema.py
View File

@@ -76,6 +76,21 @@ def fmt_propname(propname):
return '**{}**'.format(esc_underscores(propname))
def deprecated_to_deleted(vername):
"""We promise a 6 month minumum deprecation period, and versions are every 3 months"""
assert vername.startswith('v')
base = [int(s) for s in vername[1:].split('.')[0:2]]
if base == [0, 12]:
base = [22, 8]
base[1] += 9
if base[1] > 12:
base[0] += 1
base[1] -= 12
# Christian points out versions should sort well lexographically,
# so we zero-pad single-digits.
return 'v{}.{:0>2}'.format(base[0], base[1])
def output_member(propname, properties, is_optional, indent, print_type=True, prefix=None):
"""Generate description line(s) for this member"""
@@ -94,6 +109,11 @@ def output_member(propname, properties, is_optional, indent, print_type=True, pr
output_range(properties)
if 'deprecated' in properties:
output(" **deprecated, removal in {}**".format(deprecated_to_deleted(properties['deprecated'])))
if 'added' in properties:
output(" *(added {})*".format(properties['added']))
if not is_untyped and properties['type'] == 'object':
output(':\n')
output_members(properties, indent + ' ')
@@ -122,7 +142,7 @@ def has_members(sub):
for p in list(sub['properties'].keys()):
if len(sub['properties'][p]) == 0:
continue
if 'deprecated' in sub['properties'][p]:
if sub['properties'][p].get('deprecated') is True:
continue
return True
return False
@@ -132,7 +152,7 @@ def output_members(sub, indent=''):
"""Generate lines for these properties"""
warnings = []
# Remove deprecated and stub properties, collect warnings
# Remove deprecated: True and stub properties, collect warnings
# (Stubs required to keep additionalProperties: false happy)
# FIXME: It fails for schemas which have only an array type with
@@ -146,7 +166,7 @@ def output_members(sub, indent=''):
# }
# Checkout the schema of `staticbackup`.
for p in list(sub['properties'].keys()):
if len(sub['properties'][p]) == 0 or 'deprecated' in sub['properties'][p]:
if len(sub['properties'][p]) == 0 or sub['properties'][p].get('deprecated') is True:
del sub['properties'][p]
elif p.startswith('warning'):
warnings.append(p)