-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
format_signatures: Fix whitespace issues and add tests #381
Open
jbms
wants to merge
1
commit into
main
Choose a base branch
from
fix-format-signatures-space
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbms
force-pushed
the
fix-format-signatures-space
branch
from
August 6, 2024 19:16
8a8beba
to
d58344e
Compare
jbms
force-pushed
the
fix-format-signatures-space
branch
2 times, most recently
from
August 6, 2024 19:51
b0b77a7
to
31c4c84
Compare
jbms
force-pushed
the
fix-format-signatures-space
branch
from
August 6, 2024 21:41
31c4c84
to
af2303c
Compare
2bndy5
reviewed
Aug 6, 2024
@@ -151,6 +151,9 @@ def _transform_node(node): | |||
if isinstance(node, docutils.nodes.Text): | |||
return replacements.get(id(node)) or [] | |||
new_node = node.copy() | |||
# Ensure the new node does not contain any children. `desc_sig_space`, | |||
# for example, adds a default child text node with content " ". | |||
del new_node[:] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would this be better?
Suggested change
del new_node[:] | |
new_node.children.clear() |
I think the current change would delete children and attributes, no?
Comment on lines
+197
to
+218
first_name_text_node: Optional[docutils.nodes.Text] = None | ||
for adjusted_node in adjusted_nodes: | ||
node: docutils.nodes.Element | ||
for node in adjusted_node.findall( | ||
lambda node: ( | ||
isinstance(node, sphinx.addnodes.desc_addname) | ||
or ( | ||
isinstance(node, sphinx.addnodes.desc_name) | ||
and "sig-name-nonprimary" not in node["classes"] | ||
) | ||
) | ||
): | ||
for text_node in cast(docutils.nodes.Element, node).findall( | ||
docutils.nodes.Text | ||
): | ||
first_name_text_node = text_node | ||
break | ||
if first_name_text_node is not None: | ||
break | ||
if first_name_text_node is not None: | ||
break | ||
return first_name_text_node |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why all the breaks? Seems like a simple return makes sense.
Suggested change
first_name_text_node: Optional[docutils.nodes.Text] = None | |
for adjusted_node in adjusted_nodes: | |
node: docutils.nodes.Element | |
for node in adjusted_node.findall( | |
lambda node: ( | |
isinstance(node, sphinx.addnodes.desc_addname) | |
or ( | |
isinstance(node, sphinx.addnodes.desc_name) | |
and "sig-name-nonprimary" not in node["classes"] | |
) | |
) | |
): | |
for text_node in cast(docutils.nodes.Element, node).findall( | |
docutils.nodes.Text | |
): | |
first_name_text_node = text_node | |
break | |
if first_name_text_node is not None: | |
break | |
if first_name_text_node is not None: | |
break | |
return first_name_text_node | |
for adjusted_node in adjusted_nodes: | |
node: docutils.nodes.Element | |
for node in adjusted_node.findall( | |
lambda node: ( | |
isinstance(node, sphinx.addnodes.desc_addname) | |
or ( | |
isinstance(node, sphinx.addnodes.desc_name) | |
and "sig-name-nonprimary" not in node["classes"] | |
) | |
) | |
): | |
for text_node in cast(docutils.nodes.Element, node).findall( | |
docutils.nodes.Text | |
): | |
return text_node | |
return None |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.