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

Job	Run time
lint	1m 8s
build-splicer (windows-latest)	11s
build-splicer (ubuntu-latest)	5s
build (debug)	7s
build (release)	9s
build (weval)	8s
test-example	42s
test (23.10.0, ubuntu-latest, debug)	7m 34s
test (23.10.0, ubuntu-latest, release)	6m 47s
test (23.10.0, windows-latest, release)	7m 51s
test (23.10.0, windows-latest, debug)	9m 10s
test (23.10.0, ubuntu-latest, weval)	10m 12s
test (23.10.0, windows-latest, weval)	13m 1s
test (23.10.0, macos-latest, debug)	5m 42s
test (23.10.0, macos-latest, release)	4m 19s
test (23.10.0, macos-latest, weval)	8m 26s
	1h 15m 32s

Provide feedback