chore(docs): spelling / typos correction by Schievel1 · Pull Request #960 · HaoboGu/rmk

Schievel1 · 2026-07-16T06:20:49Z

Just a few mistakes I found in the docs.
I will keep this as draft for the time being until I feel like I found enough.

Signed-off-by: Pascal Jäger <pascal.jaeger@bode-global.com>

github-actions · 2026-07-16T06:35:36Z

Size Report

Example	main	PR	Diff	.text
`use_config/nrf52832_ble`	391.8 KiB	391.8 KiB	+0.00% ⬆️	+4
`use_config/nrf52840_ble`	436.6 KiB	436.6 KiB	+0.00% ⬇️	-4
`use_config/nrf52840_ble_split (central)`	490.6 KiB	490.6 KiB	+0.00%	0
`use_config/nrf52840_ble_split (peripheral)`	315.9 KiB	315.9 KiB	+0.00%	0
`use_config/pi_pico_w_ble`	664.6 KiB	664.6 KiB	+0.00%	0
`use_config/rp2040`	145.7 KiB	145.7 KiB	+0.00% ⬆️	+4
`use_config/rp2040_split (central)`	159.2 KiB	159.2 KiB	+0.00%	0
`use_config/rp2040_split (peripheral)`	27.8 KiB	27.8 KiB	+0.00%	0
`use_config/stm32f1`	61.9 KiB	61.9 KiB	+0.00%	0
`use_config/stm32h7`	99.0 KiB	99.0 KiB	+0.00%	0
`use_rust/nrf52832_ble`	380.0 KiB	380.0 KiB	+0.00% ⬆️	+8
`use_rust/nrf52840_ble`	433.7 KiB	433.7 KiB	+0.00%	0
`use_rust/nrf52840_ble_split (central)`	499.3 KiB	499.3 KiB	+0.00% ⬆️	+4
`use_rust/nrf52840_ble_split (peripheral)`	312.3 KiB	312.3 KiB	+0.00%	0
`use_rust/pi_pico_w_ble`	664.9 KiB	664.9 KiB	+0.00%	0
`use_rust/rp2040`	145.3 KiB	145.3 KiB	+0.00% ⬆️	+4
`use_rust/rp2040_split (central)`	158.1 KiB	158.1 KiB	+0.00%	0
`use_rust/rp2040_split (peripheral)`	28.2 KiB	28.2 KiB	+0.00%	0
`use_rust/stm32f1`	61.2 KiB	61.2 KiB	+0.00%	0
`use_rust/stm32h7`	119.7 KiB	119.7 KiB	+0.00%	0

use_config/nrf52832_ble — 391.8 KiB → 391.8 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 362580	   4588	  34016	 401184	  61f20	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 362576	   4588	  34016	 401180	  61f1c	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +4  +0.0%      +4    .text
  -5.7%      -3  [ = ]       0    [Unmapped]
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.7%     -54  [ = ]       0    .debug_abbrev
  -0.0%     -97  [ = ]       0    .debug_line
  -0.0%    -135  [ = ]       0    .debug_str
  -0.0%    -313  [ = ]       0    .debug_info
  -0.0%    -608  +0.0%      +4    TOTAL

use_config/nrf52840_ble — 436.6 KiB → 436.6 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 394944	   4596	  47576	 447116	  6d28c	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 394948	   4596	  47576	 447120	  6d290	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +877  [ = ]       0    .debug_str
  +0.0%    +111  [ = ]       0    .debug_info
  +0.0%     +92  [ = ]       0    .strtab
  +0.5%     +39  [ = ]       0    .debug_abbrev
  +9.3%      +5  [ = ]       0    [Unmapped]
  -0.0%      -4  -0.0%      -4    .text
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -42  [ = ]       0    .debug_line
  +0.0% +1.04Ki  -0.0%      -4    TOTAL

use_config/nrf52840_ble_split (central) — 490.6 KiB → 490.6 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 451660	   4652	  46072	 502384	  7aa70	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 451660	   4652	  46072	 502384	  7aa70	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +2  [ = ]       0    .debug_loc
  -3.4%      -2  [ = ]       0    [Unmapped]
  [ = ]       0  [ = ]       0    TOTAL

use_config/nrf52840_ble_split (peripheral) — 315.9 KiB → 315.9 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 291812	   4468	  27152	 323432	  4ef68	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 291812	   4468	  27152	 323432	  4ef68	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_str
  +0.0%     +16  [ = ]       0    .strtab
  +5.7%      +3  [ = ]       0    [Unmapped]
  +0.0%      +2  [ = ]       0    .debug_loc
  +0.0%      +1  [ = ]       0    .debug_line
  -0.0%      -2  [ = ]       0    .debug_info
  +0.0%     +52  [ = ]       0    TOTAL

use_config/pi_pico_w_ble — 664.6 KiB → 664.6 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 626712	      0	  53860	 680572	  a627c	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 626712	      0	  53860	 680572	  a627c	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +10  [ = ]       0    .debug_loc
  -0.0%      -1  [ = ]       0    .debug_line
  -1.8%      -1  [ = ]       0    [Unmapped]
  +0.0%      +8  [ = ]       0    TOTAL

use_config/rp2040 — 145.7 KiB → 145.7 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 134428	      0	  14788	 149216	  246e0	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 134424	      0	  14788	 149212	  246dc	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +714  [ = ]       0    .debug_str
  +0.0%     +49  [ = ]       0    .strtab
  +0.0%     +18  [ = ]       0    .debug_line
  +0.0%      +9  [ = ]       0    .debug_info
  +0.0%      +4  +0.0%      +4    .text
 -10.2%      -6  [ = ]       0    [Unmapped]
  +0.0%    +788  +0.0%      +4    TOTAL

use_config/rp2040_split (central) — 159.2 KiB → 159.2 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 147384	      0	  15652	 163036	  27cdc	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 147384	      0	  15652	 163036	  27cdc	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +10  [ = ]       0    .debug_loc
  +3.4%      +2  [ = ]       0    [Unmapped]
  +0.0%     +12  [ = ]       0    TOTAL

use_config/rp2040_split (peripheral) — 27.8 KiB → 27.8 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  25612	     60	   2796	  28468	   6f34	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  25612	     60	   2796	  28468	   6f34	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

use_config/stm32f1 — 61.9 KiB → 61.9 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  56504	     28	   6804	  63336	   f768	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  56504	     28	   6804	  63336	   f768	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

use_config/stm32h7 — 99.0 KiB → 99.0 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  92152	    264	   8992	 101408	  18c20	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  92152	    264	   8992	 101408	  18c20	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +142  [ = ]       0    .debug_line
  -7.7%      -4  [ = ]       0    [Unmapped]
  -0.2%    -126  [ = ]       0    .strtab
  -0.1% -1.46Ki  [ = ]       0    .debug_str
  -0.0% -1.45Ki  [ = ]       0    TOTAL

use_rust/nrf52832_ble — 380.0 KiB → 380.0 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 351552	   4588	  33000	 389140	  5f014	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 351544	   4588	  33000	 389132	  5f00c	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
   +55%     +24  [ = ]       0    [Unmapped]
  +0.0%      +8  +0.0%      +8    .text
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -97  [ = ]       0    .debug_line
  -0.0%    -135  [ = ]       0    .debug_str
  -0.0%    -234  [ = ]       0    .debug_info
  -0.0%    -444  +0.0%      +8    TOTAL

use_rust/nrf52840_ble — 433.7 KiB → 433.7 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 395676	   4588	  43864	 444128	  6c6e0	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 395676	   4588	  43864	 444128	  6c6e0	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -9.3%      -4  [ = ]       0    [Unmapped]
  -0.1%    -486  [ = ]       0    .strtab
  -0.1% -4.29Ki  [ = ]       0    .debug_str
  -0.1% -4.77Ki  [ = ]       0    TOTAL

use_rust/nrf52840_ble_split (central) — 499.3 KiB → 499.3 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 455640	   4652	  50952	 511244	  7cd0c	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 455636	   4652	  50952	 511240	  7cd08	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1% +5.32Ki  [ = ]       0    .debug_str
  +0.1%    +587  [ = ]       0    .strtab
  +0.0%     +10  [ = ]       0    .debug_loc
  +0.0%      +4  +0.0%      +4    .text
  -8.3%      -4  [ = ]       0    [Unmapped]
  -0.0%     -57  [ = ]       0    .debug_info
  -0.0%    -131  [ = ]       0    .debug_line
  +0.1% +5.72Ki  +0.0%      +4    TOTAL

use_rust/nrf52840_ble_split (peripheral) — 312.3 KiB → 312.3 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 289892	   4468	  25400	 319760	  4e110	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 289892	   4468	  25400	 319760	  4e110	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +10  [ = ]       0    .debug_loc
  -3.4%      -2  [ = ]       0    [Unmapped]
  +0.0%      +8  [ = ]       0    TOTAL

use_rust/pi_pico_w_ble — 664.9 KiB → 664.9 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 626884	      0	  54004	 680888	  a63b8	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 626884	      0	  54004	 680888	  a63b8	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +5  [ = ]       0    .debug_info
 -11.1%      -5  [ = ]       0    [Unmapped]
  -0.0%      -8  [ = ]       0    .debug_line
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -22  [ = ]       0    .strtab
  -0.0%     -44  [ = ]       0    .debug_str
  -0.0%     -84  [ = ]       0    TOTAL

use_rust/rp2040 — 145.3 KiB → 145.3 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 134124	      0	  14660	 148784	  24530	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 134120	      0	  14660	 148780	  2452c	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +17  [ = ]       0    .debug_line
  +0.0%      +9  [ = ]       0    .debug_info
  +0.0%      +4  +0.0%      +4    .text
 -14.6%      -6  [ = ]       0    [Unmapped]
  -0.0%      -8  [ = ]       0    .strtab
  -0.0%     -72  [ = ]       0    .debug_str
  -0.0%     -56  +0.0%      +4    TOTAL

use_rust/rp2040_split (central) — 158.1 KiB → 158.1 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 146488	      0	  15436	 161924	  27884	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 146488	      0	  15436	 161924	  27884	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +36  [ = ]       0    .debug_str
  +0.0%      +4  [ = ]       0    .strtab
  -3.6%      -2  [ = ]       0    [Unmapped]
  -0.0%      -9  [ = ]       0    .debug_info
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -19  [ = ]       0    .debug_line
  [ = ]       0  [ = ]       0    TOTAL

use_rust/rp2040_split (peripheral) — 28.2 KiB → 28.2 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  25712	     60	   3060	  28832	   70a0	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  25712	     60	   3060	  28832	   70a0	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +733  [ = ]       0    .debug_str
  +0.2%     +38  [ = ]       0    .strtab
  +2.9%      +1  [ = ]       0    [Unmapped]
  +0.1%    +772  [ = ]       0    TOTAL

use_rust/stm32f1 — 61.2 KiB → 61.2 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  55916	     28	   6772	  62716	   f4fc	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  55916	     28	   6772	  62716	   f4fc	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +1  [ = ]       0    .debug_str
  +0.0%      +1  [ = ]       0    .strtab
  -4.9%      -2  [ = ]       0    [Unmapped]
  [ = ]       0  [ = ]       0    TOTAL

use_rust/stm32h7 — 119.7 KiB → 119.7 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 107292	    320	  14940	 122552	  1deb8	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 107292	    320	  14940	 122552	  1deb8	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +10  [ = ]       0    .debug_loc
  -3.9%      -2  [ = ]       0    [Unmapped]
  +0.0%      +8  [ = ]       0    TOTAL

chore(docs): spelling / typos correction

c850231

Signed-off-by: Pascal Jäger <pascal.jaeger@bode-global.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(docs): spelling / typos correction#960

chore(docs): spelling / typos correction#960
Schievel1 wants to merge 1 commit into
HaoboGu:mainfrom
Schievel1:doc-correction-run

Schievel1 commented Jul 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

Schievel1 commented Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 16, 2026

Size Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Schievel1 commented Jul 16, 2026 •

edited

Loading