Skip to content

Fixing bug in _index.md #19

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

Merged
merged 1 commit into from
Jun 22, 2023
Merged

Fixing bug in _index.md #19

merged 1 commit into from
Jun 22, 2023

Conversation

davidalayachew
Copy link
Contributor

@davidalayachew davidalayachew commented Jun 22, 2023

Since "2020)" was on its own separate line, markdown interpreted it as a start of an ordered list. Just like this.

1)
2)
3)

And then when that markdown got converted to HTML, it got converted into a literal <ol> tag, which stands for Ordered List - http://html5doctor.com/element-index/#ol

However, in order for an Ordered List to show anything, it must have within it an <li> tag, which stands for List Item. Since there is no such tag, HTML treats this as an empty list and shows nothing, resulting in the bug.

Here is a snippet from the literal HTML from this link -- https://openjdk.org/projects/amber/

<li>
    <a href="design-notes/patterns/type-patterns-in-switch">Type Patterns in <code>switch</code></a> (September 
    <ol type="1" start="2020"></ol>
</li>

Progress

  • Change must not contain extraneous whitespace

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/amber-docs.git pull/19/head:pull/19
$ git checkout pull/19

Update a local copy of the PR:
$ git checkout pull/19
$ git pull https://git.openjdk.org/amber-docs.git pull/19/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 19

View PR using the GUI difftool:
$ git pr show -t 19

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/amber-docs/pull/19.diff

Since "2020)" was on its own separate line, markdown interpreted it as a start of an ordered list. Just like this.

1)
2)
3)

And then when that markdown got converted to HTML, it got converted into a literal <ol> tag, which stands for Ordered List - http://html5doctor.com/element-index/#ol

However, in order for an Ordered List to show anything, it must have within it an <li> tag, which stands for List Item. Since there is no such tag, HTML treats this as an empty list and shows nothing, resulting in the bug.

Here is a snippet from the literal HTML from this link -- https://openjdk.org/projects/amber/

<li><a href="design-notes/patterns/type-patterns-in-switch">Type Patterns in <code>switch</code></a> (September
<ol type="1" start="2020"></ol>
</li>
@bridgekeeper
Copy link

bridgekeeper bot commented Jun 22, 2023

👋 Welcome back davidalayachew! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Jun 22, 2023

@davidalayachew This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

Fixing bug in _index.md

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 22, 2023
@davidalayachew
Copy link
Contributor Author

/integrate

@openjdk openjdk bot added the sponsor Pull request is ready to be sponsored label Jun 22, 2023
@openjdk
Copy link

openjdk bot commented Jun 22, 2023

@davidalayachew
Your change (at version ec6b334) is now ready to be sponsored by a Committer.

@GavinBierman GavinBierman merged commit 8ef9984 into openjdk:master Jun 22, 2023
@davidalayachew davidalayachew deleted the patch-1 branch June 22, 2023 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored
Development

Successfully merging this pull request may close these issues.

2 participants