Skip to content

Commit 6232f2b

Browse files
Fixes Spelling Errors
This commits fixes some spelling mistakes and Adds guide to use GNU Aspell to do the same. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 7e62d83 commit 6232f2b

8 files changed

Lines changed: 27 additions & 18 deletions

File tree

docs/source/scancode-toolkit/cli-reference/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**Command Line Interface Referance**
1+
**Command Line Interface Reference**
22
====================================
33

44
.. toctree::
@@ -10,7 +10,7 @@
1010
simple-examples
1111

1212
..
13-
[ToAdd]
13+
[To-Add]
1414
core-options
1515
output-format
1616
output-filters-and-control

docs/source/scancode-toolkit/contribute/contrib_dev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ either using a checkout or a download, without needing a compiler and toolchain
2727
The corresponding source code for the pre-built binaries are store in a separate repository at
2828
https://github.com/nexB/scancode-thirdparty-src.
2929

30-
We store bundled thirdparty components and libraries in the ``thirdparty`` directory. Python
30+
We store bundled third-party components and libraries in the ``thirdparty`` directory. Python
3131
libraries are stored as wheels, eventually pre-built if the corresponding wheel is not available
3232
in the Pypi repository. Some of these components may be advanced builds with bug fixes or advanced
3333
patches.

docs/source/scancode-toolkit/contribute/contrib_doc.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Contributing to the Documentation
22
=================================
33

4-
Continious Integration
4+
Continuous Integration
55
----------------------
66

77
The documentations are checked on every new commit through Travis-CI, so that common errors are
@@ -60,13 +60,13 @@ What is checked:
6060
- lines should not be longer than 100 characters - D001
6161

6262
- RST exception: line with no whitespace except in the beginning
63-
- RST exception: lines with http or https urls
63+
- RST exception: lines with http or https URLs
6464
- RST exception: literal blocks
6565
- RST exception: rst target directives
6666

6767
- no trailing whitespace - D002
6868
- no tabulation for indentation - D003
69-
- no carriage returns (use unix newlines) - D004
69+
- no carriage returns (use UNIX newlines) - D004
7070
- no newline at end of file - D005
7171

7272
Extra Style Checks
@@ -87,7 +87,7 @@ Extra Style Checks
8787

8888
-, for subsections
8989

90-
^, for subsubsections
90+
^, for sub-subsections
9191

9292
", for paragraphs
9393

@@ -128,6 +128,15 @@ Extra Style Checks
128128

129129
5. Using ``:ref:`` only when necessary
130130

131-
Use ``:ref:`` to create internal links only when needed, i.e. it is referanced somewhere.
132-
Do not create referances for all the sections and then only referance some of them, because
133-
this created unnecessary referances. This also generates ERROR in ``restructuredtext-lint``.
131+
Use ``:ref:`` to create internal links only when needed, i.e. it is referenced somewhere.
132+
Do not create references for all the sections and then only reference some of them, because
133+
this created unnecessary references. This also generates ERROR in ``restructuredtext-lint``.
134+
135+
6. Spelling
136+
137+
You should check for spelling errors before you push changes. `Aspell <http://aspell.net/>`_
138+
is a GNU project Command Line tool you can use for this purpose. Download and install Aspell,
139+
then execute ``aspell check <file-name>`` for all the files changed. Be careful about not
140+
changing commands or other stuff as Aspell gives prompts for a lot of them. Also delete the
141+
temporary ``.bak`` files generated. Refer the `manual <http://aspell.net/man-html/>`_ for more
142+
information on how to use.

docs/source/scancode-toolkit/contribute/cut_new_release.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ How to cut a new release:
2828
- upload the release archives created in the ``dist/`` directory to the GitHub release page.
2929

3030
- save the release as a draft. Use the previous release notes to create notes in the same style.
31-
Ensure that the link to thirdparty source code is present.
31+
Ensure that the link to third-party source code is present.
3232

3333
- test the downloads.
3434

docs/source/scancode-toolkit/contribute/roadmap.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Copyrights
4848
- |white_check_mark| speed up copyright detection
4949
- |white_check_mark| improved detected lines range
5050
- |white_check_mark| streamline grammar of copyright parser
51-
- |white_check_mark| normalize holders and authors for summarization
51+
- |white_check_mark| normalize holders and authors for summarizing
5252
- |white_check_mark| normalize and streamline results data format
5353

5454
Core features
@@ -121,7 +121,7 @@ Other work in progress
121121
----------------------
122122

123123
- ScanCode server: Spawned as its own project: https://github.com/nexB/scancode-server. Will
124-
include Integration / webhooks for Github, Bitbucket.
124+
include Integration / webhooks for GitHub, Bitbucket.
125125
- VulnerableCode: NVD and CVE lookups: Spawned as its own project: https://github.com/nexB/vulnerablecode
126126
- ScanCode Workbench: desktop app for scan review: Spawned as its own project:
127127
https://github.com/nexB/scancode-workbench
@@ -158,8 +158,8 @@ Core scans
158158
- |white_check_mark| file information (size, type, etc.)
159159
- |white_check_mark| URLs, emails, authors
160160

161-
Ouputs and UI
162-
^^^^^^^^^^^^^
161+
Outputs and UI
162+
^^^^^^^^^^^^^^
163163
- |white_check_mark| JSON compact and pretty
164164
- |white_check_mark| plain HTML tables, also usable in a spreadsheet
165165
- |white_check_mark| fancy HTML 'app' with a file tree navigation, and scan results filtering,

docs/source/scancode-toolkit/explanations/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
overview
88

99
..
10-
[ToAdd]
10+
[To-Add]
1111
file_collect_classify
1212
extract
1313
rules_engine

docs/source/scancode-toolkit/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**Scancode-Toolkit Documentation**
1+
**ScanCode-Toolkit Documentation**
22
==================================
33

44
.. toctree::
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Support
22
=======
33

4-
Post questions and bugs as Github tickets at: https://github.com/nexB/scancode-toolkit/issues
4+
Post questions and bugs as GitHub tickets at: https://github.com/nexB/scancode-toolkit/issues
55

66
Ask question on StackOverflow using the [scancode] tag.

0 commit comments

Comments
 (0)