Skip to content
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

Documentation/lkl.txt: fix Markdown formatting #491

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alyssais
Copy link

@alyssais alyssais commented Dec 10, 2020

Despite being a .txt file, this is symlinked as README.md at the root,
so must be supposed to be Markdown. Throughout the file, triple
backticks (```) were used around Markdown code blocks, but those code
blocks were also indented. Both of these are ways of making a
Markdown code block, but together they result in a top-level code
block containing code that is indented four spaces, which was probably
not the intention. Additionally, the backticks were not themselves
indented, which had the effect of terminating the list they were
supposed to be contained in, resulting in markup like this:

  ...
  <li>
    <p>IPv6 gateway address</p>
    <p>key: "gateway6"<br>value type: string</p>
    <p>the gateway IPv6 address of the LKL network stack.</p>
  </li>
</ul>
<pre><code>
     "gateway6":"2001:db8:0:f101::1"
</code></pre>
<ul>
  <li>
    <p>Debug</p>
    ...

...which was clearly not the intention.

Signed-off-by: Alyssa Ross [email protected]


This change is Reviewable

Despite being a .txt file, this is symlinked as README.md at the root,
so must be supposed to be Markdown.  Throughout the file, triple
backticks (```) were used around Markdown code blocks, but those code
blocks were also indented.  Both of these are ways of making a
Markdown code block, but together they result in a top-level code
block containing code that is indented four spaces, which was probably
not the intention.  Additionally, the backticks were not themselves
indented, which had the effect of terminating the list they were
supposed to be contained in, resulting in markup like this:

  ...
  <li>
    <p>IPv6 gateway address</p>
    <p>key: "gateway6"<br>value type: string</p>
    <p>the gateway IPv6 address of the LKL network stack.</p>
  </li>
</ul>
<pre><code>
     "gateway6":"2001:db8:0:f101::1"
</code></pre>
<ul>
  <li>
    <p>Debug</p>
    ...

...which was clearly not the intention.

Signed-off-by: Alyssa Ross <[email protected]>
@Rondom
Copy link

Rondom commented Dec 10, 2020

I think it is better to convert it to reStructuredText because that is what is used in Documentation/. GitHub supports parsing reStructuredText when it is called *.rst. See files in Documentation/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants