docs(system): fix bad description #2659
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
VSCode
Old:
![grafik](https://private-user-images.githubusercontent.com/1579362/303920570-ddb4c385-b375-40af-9f60-221c979a6a3f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwNDkzODIsIm5iZiI6MTczOTA0OTA4MiwicGF0aCI6Ii8xNTc5MzYyLzMwMzkyMDU3MC1kZGI0YzM4NS1iMzc1LTQwYWYtOWY2MC0yMjFjOTc5YTZhM2YucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDhUMjExMTIyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MzYwZGM0ZTMzNDhhMTRhODZlZDlkYjZmODIzNGJhZjRhYTg2MzUzMTAxYjA5MDIyOTZhZjZjZjExYjNmYTk0MSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.TCv8b_amdolyHVESidIACpHCjyni35AfKQpuhKt8IrI)
![grafik](https://private-user-images.githubusercontent.com/1579362/303920550-d33efc3b-49b6-4980-bd6c-75257ab4ba92.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwNDkzODIsIm5iZiI6MTczOTA0OTA4MiwicGF0aCI6Ii8xNTc5MzYyLzMwMzkyMDU1MC1kMzNlZmMzYi00OWI2LTQ5ODAtYmQ2Yy03NTI1N2FiNGJhOTIucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDhUMjExMTIyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MjMzZDM5ZGY0N2I0MmM0Mjk5YmFiMGJiOTAxOTcyZTFjYmVjNzc2MDQyODkyMTJjNzJiZmVkN2Q4M2U4YTMxMCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.HyCnW7Xh7zgivve3baUR6Hx3XzaYRIi4FGwhnDjRo8I)
New:
ApiDocs
Old:
![grafik](https://private-user-images.githubusercontent.com/1579362/303920490-56086516-eb25-4e3f-9255-1230c81c5660.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwNDkzODIsIm5iZiI6MTczOTA0OTA4MiwicGF0aCI6Ii8xNTc5MzYyLzMwMzkyMDQ5MC01NjA4NjUxNi1lYjI1LTRlM2YtOTI1NS0xMjMwYzgxYzU2NjAucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDhUMjExMTIyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZTdkNGM0NDJhMjJjOTE0YjRiZjJkMzIxMDJmN2JmNjhmMDk1NDI4M2JiYWFhZGM3YzYxNTViZmM3NTQwYmM1MSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.JQ9d9Fa1p_wjTV_yOw5ZfI8UbDdLW0H1K4JxPTP1JOA)
![grafik](https://private-user-images.githubusercontent.com/1579362/303920503-8afa3bab-1fdc-40eb-bc49-03294eca1dea.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwNDkzODIsIm5iZiI6MTczOTA0OTA4MiwicGF0aCI6Ii8xNTc5MzYyLzMwMzkyMDUwMy04YWZhM2JhYi0xZmRjLTQwZWItYmM0OS0wMzI5NGVjYTFkZWEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDhUMjExMTIyWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YzllMmQwYjY2N2E1NThlMDkyNGM4NmI3NzM4ZjZmZmE1OTYxZGFjOWZkNDU2NmQwNzk4OThmYTZmYTgzNjIyNyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.jvSGCl2io5nPgDyDKRJ-AS_D0GR4cA91t_QBv5Wz3J0)
New:
I also checked whether there is a jsdoc-eslint rule, but sadly I couldn't find any.