chore(docs): add comments to API type in README #841

Job	Run time
lint	45s
build-splicer (ubuntu-latest)	10s
build-splicer (windows-latest)	12s
build (debug)	8s
build (weval)	13s
build (release)	10s
test-example	45s
test (23.10.0, ubuntu-latest, release)	6m 46s
test (23.10.0, ubuntu-latest, weval)	10m 13s
test (23.10.0, macos-latest, release)	5m 18s
test (23.10.0, ubuntu-latest, debug)	7m 32s
test (23.10.0, macos-latest, debug)	5m 46s
test (23.10.0, windows-latest, release)	8m 6s
test (23.10.0, windows-latest, debug)	8m 56s
test (23.10.0, macos-latest, weval)	10m 59s
test (23.10.0, windows-latest, weval)	12m 59s
	1h 18m 58s

Provide feedback