Improve Updater to not remove useful README titles #770
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
|
We should keep removing h2 if it is the first element too. Some projects use a h2 rather than a h1 to take less space in the github rendering |
stof
reviewed
Feb 24, 2017
| if ($dom->getElementsByTagName('h1')->length) { | ||
| // remove first page element if it's a <h1> or <h2>, because it's usually | ||
| // the project name or the `README` string which we don't need | ||
| if ('h1' === $dom->childNodes->item(0)->nodeName) { | ||
| $first = $dom->getElementsByTagName('h1')->item(0); |
There was a problem hiding this comment.
could be simplified:
$first = $dom->childNodes->item(0);
if ($first && ('h1' === $first->nodeName || 'h2' === $first->nodeName)) {
$first->parentNode->removeChild($first);
}My snippet also account for the case of empty readme, where there could be no first node.
There was a problem hiding this comment.
Much better! Thank you.
|
Thanks! |
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.
This tries to fix #764 by only removing the first
<h1>element if it's the first actual element of the README file.