Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add vscode spell check extension #753

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

nicu1989
Copy link
Contributor

Improvement

Description

After reviewing the process documentation it seems that there are a lot of spell mistakes so I added the VSCode extension for rst spell checking.

Related ticket

related #544 (improvement ticket)

Add spell check extension in VSCode for rst files.
If required more file types(or all) can be enabled for spell checking.

Signed-off-by: Nicolae Dicu <Nicolae.Dicu.ext@qorix.ai>
Copy link

github-actions bot commented Mar 21, 2025

License Check Results

🚀 The license check preparation job ran successfully.

Status: ⚠️ Needs Review

Click to expand output
2025/03/24 11:29:05 Downloading https://releases.bazel.build/7.4.0/release/bazel-7.4.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)

Analyzing: target //docs:license.check.python (92 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (99 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (130 packages loaded, 824 targets configured)

Analyzing: target //docs:license.check.python (143 packages loaded, 2445 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (148 packages loaded, 4611 targets configured)

INFO: Analyzed target //docs:license.check.python (149 packages loaded, 4736 targets configured).
[9 / 13] JavaToolchainCompileClasses external/rules_java~/toolchains/platformclasspath_classes; 0s processwrapper-sandbox ... (2 actions running)
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java~/toolchains/platformclasspath.jar; 0s processwrapper-sandbox
[12 / 13] Building docs/license.check.python.jar (); 0s multiplex-worker
INFO: Found 1 target...
Target //docs:license.check.python up-to-date:
  bazel-bin/docs/license.check.python
  bazel-bin/docs/license.check.python.jar
INFO: Elapsed time: 18.996s, Critical Path: 2.36s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/docs/license.check.python docs/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/score -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 69 items.
[main] INFO Found 45 items.
[main] INFO Querying ClearlyDefined for license data for 25 items.
[main] INFO Found 25 items.
[main] INFO License information could not be automatically verified for the following content:
[main] INFO 
[main] INFO pypi/pypi/-/docutils/0.21.2
[main] INFO 
[main] INFO This content is either not correctly mapped by the system, or requires review.
[main] INFO A review is required for pypi/pypi/-/docutils/0.21.2.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19880 .

Copy link

The created documentation from the pull request is available at: docu-html

@nicu1989 nicu1989 mentioned this pull request Mar 21, 2025
@AlexanderLanin
Copy link
Member

Does it help or does it highlight half the text including lots of normal words that it is not ware of?

Signed-off-by: Nicolae Dicu <Nicolae.Dicu.ext@qorix.ai>
@nicu1989
Copy link
Contributor Author

Does it help or does it highlight half the text including lots of normal words that it is not ware of?

Created ignore list for most false positives, so hopefully it will be more helpful now for correcting spell mistakes.

@nicu1989 nicu1989 requested a review from AlexanderLanin March 24, 2025 11:32
@AlexanderLanin AlexanderLanin requested a review from hoe-jo March 24, 2025 11:43
@AlexanderLanin
Copy link
Member

@hoe-jo you have most experience with writing docs? Would that help? Currently docs are indeed difficult to read because of the many spelling mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants