Typos and broken table formatting in RandomX's configuration.md ( https://github.com/tevador/RandomX/blob/1e9d4b2df63fa6edf46b06789486e23c0fcaa55a/doc/configuration.md )

[willy-b]

Hello RandomX team!

Thanks so much for this project and the excellent documentation.

In case it is useful, I wanted to alert the team to a couple of harmless typos in the configuration.md and a broken table that may nonetheless distract some readers and thus may be of interest to correct:

---

• In the sentence (

  RandomX/doc/configuration.md

  Line 27 in 1e9d4b2

  Not all of the parameters can be changed safely and most parameters have some contraints on what values can be selected (checked at compile-time).

  )

  Not all of the parameters can be changed safely and most parameters have some contraints on what values can be selected (checked at compile-time).

  "contraints" should be "constraints".

• In the sentence (

  RandomX/doc/configuration.md

  Line 193 in 1e9d4b2

  There is a total of 29 different instructions. The sum of frequencies must be equal to 256.

  )

There is a total of 29 different instructions.

"There is" should be "There are".

• The table showing a safe custom reconfiguration is not formatted correctly and is not displaying as a table
  In:

  Example of a safe custom configuration:

  	default	custom
  RANDOMX_FREQ_IROR_R	8	5
  RANDOMX_FREQ_IROL_R	2	5

  	default	custom
  RANDOMX_FREQ_FADD_R	16	17
  RANDOMX_FREQ_FSUB_R	16	15

  	default	custom
  RANDOMX_FREQ_FADD_M	5	4
  RANDOMX_FREQ_FSUB_M	5	6

The first column headers separator (

RandomX/doc/configuration.md

Line 200 in 1e9d4b2

|-|------|------|-|

)
should not be

|-|------|------|-|

but rather

|-|------|------|

so that RANDOMX_FREQ_IROR_R and RANDOMX_FREQ_IROL_R also show correctly.

Right now they do NOT:

• In the sentence (

  RandomX/doc/configuration.md

  Line 218 in 1e9d4b2

  These checks can be disabled by definining `RANDOMX_UNSAFE` when building RandomX, e.g. by using `-DRANDOMX_UNSAFE` command line switch in GCC or MSVC. It is not recommended to disable these checks except for testing purposes.

  )

  These checks can be disabled by definining RANDOMX_UNSAFE when building RandomX, e.g. by using -DRANDOMX_UNSAFE command line switch in GCC or MSVC.

  "definining" should be "defining".

---

Thanks so much!