afritz1 / OpenTESArena

Open-source re-implementation of The Elder Scrolls: Arena.
MIT License
987 stars 68 forks source link

Changing install instructions to an ordered list #210

Closed Thunderforge closed 3 years ago

Thunderforge commented 3 years ago

Instead of an unordered list (bullet points), the instructions are now an ordered list (1, 2, 3) since they are sequential instructions that need to be followed.

afritz1 commented 3 years ago

Don't know why I didn't think of this. It's weird that all the numbers in your changes are 1 though but maybe that's how Markdown works.

Thunderforge commented 3 years ago

It's weird that all the numbers in your changes are 1 though but maybe that's how Markdown works.

In Markdown, the exact value is actually ignored and it is sequential from whatever the first number is. So if you do:

5. Foo
7. Bar
11. Baz

then it renders as

  1. Foo
  2. Bar
  3. Baz

A common practice is to make them all ones so that it starts at number one and then the rest don't matter. This is convenient if you change instructions later; if you had

1. Foo
2. Bar
3. Baz
4. Blarg

And you decided to eliminate step 2, then you don't have

1. Foo
3. Baz
4. Blarg

that renders as

  1. Foo
  2. Baz
  3. Blarg

Instead you would have

1. Foo
1. Baz
1. Blarg

And it renders as

  1. Foo
  2. Baz
  3. Blarg
afritz1 commented 3 years ago

Okay.