Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 23:21:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added support to handle \versionadded in a reasonable way.

Browse source
This commit is contained in:
Fred Drake 1999-01-29 22:12:29 +00:00
parent 170e190f26
commit 1dd152d036
1 changed files with 19 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

28
Doc/tools/sgmlconv/docfixer.py
View file

@ -155,8 +155,10 @@ def rewrite_descriptor(doc, descriptor):
# 2. Create a <signature> from the name attribute and <args>. # 2. Create a <signature> from the name attribute and <args>.
# 3. Create additional <signature>s from <*line{,ni}> elements, # 3. Create additional <signature>s from <*line{,ni}> elements,
# if found. # if found.
# 4. Move remaining child nodes to a <description> element. # 4. If a <versionadded> is found, move it to an attribute on the
# 5. Put it back together. # descriptor.
# 5. Move remaining child nodes to a <description> element.
# 6. Put it back together.
# #
descname = descriptor.tagName descname = descriptor.tagName
index = 1 index = 1
@ -200,16 +202,21 @@ def rewrite_descriptor(doc, descriptor):
signature.appendChild(doc.createTextNode("\n ")) signature.appendChild(doc.createTextNode("\n "))
signature.appendChild(args) signature.appendChild(args)
signature.appendChild(doc.createTextNode("\n ")) signature.appendChild(doc.createTextNode("\n "))
# 3. # 3, 4.
pos = skip_leading_nodes(children, pos + 1) pos = skip_leading_nodes(children, pos + 1)
while pos < len(children) \ while pos < len(children) \
and children[pos].nodeType == xml.dom.core.ELEMENT \ and children[pos].nodeType == xml.dom.core.ELEMENT \
and children[pos].tagName == linename: and children[pos].tagName in (linename, "versionadded"):
# this is really a supplemental signature, create <signature> if children[pos].tagName == linename:
sig = methodline_to_signature(doc, children[pos]) # this is really a supplemental signature, create <signature>
newchildren.append(sig) sig = methodline_to_signature(doc, children[pos])
newchildren.append(sig)
else:
# <versionadded added=...>
descriptor.setAttribute(
"added", children[pos].getAttribute("version"))
pos = skip_leading_nodes(children, pos + 1) pos = skip_leading_nodes(children, pos + 1)
# 4. # 5.
description = doc.createElement("description") description = doc.createElement("description")
description.appendChild(doc.createTextNode("\n")) description.appendChild(doc.createTextNode("\n"))
newchildren.append(description) newchildren.append(description)
@ -217,7 +224,7 @@ def rewrite_descriptor(doc, descriptor):
last = description.childNodes[-1] last = description.childNodes[-1]
if last.nodeType == xml.dom.core.TEXT: if last.nodeType == xml.dom.core.TEXT:
last.data = string.rstrip(last.data) + "\n " last.data = string.rstrip(last.data) + "\n "
# 5. # 6.
# should have nothing but whitespace and signature lines in <descriptor>; # should have nothing but whitespace and signature lines in <descriptor>;
# discard them # discard them
while descriptor.childNodes: while descriptor.childNodes:
@ -408,6 +415,9 @@ def create_module_info(doc, section):
typenode = doc.createElement("type") typenode = doc.createElement("type")
typenode.appendChild(doc.createTextNode(type)) typenode.appendChild(doc.createTextNode(type))
modinfo.appendChild(typenode) modinfo.appendChild(typenode)
versionadded = extract_first_element(section, "versionadded")
if versionadded:
modinfo.setAttribute("added", versionadded.getAttribute("version"))
title = get_first_element(section, "title") title = get_first_element(section, "title")
if title: if title:
children = title.childNodes children = title.childNodes