Skip to content

Commit be37218

Browse files
Add minor fixes in workbench docs
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 6c92d66 commit be37218

File tree

4 files changed

+14
-10
lines changed

4 files changed

+14
-10
lines changed

docs/source/ui-reference/chart-summary-view.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
With the chart summary view, a user can select a node in the directory tree (i.e., a directory,
88
folder or file) and display a horizontal bar chart listing the values identified in the scanned
9-
codebase -- that is, the clues detected by ScanCode Toolkit -- for a number of different
9+
codebase, i.e. the ScanCode Toolkit detections, for a number of different
1010
attributes.
1111

1212
The attributes are a subset of the columns displayed in the table view, and can be

docs/source/ui-reference/copyright-info-dashboard.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
:index:`Copyright Info Dashboard`
55
===================================
66

7-
License info dashboard summarizes the license information detected in scan for files under the selected path.
8-
Scan must have ``--license`` option for License Info Dashboard.
7+
Copyright info dashboard summarizes the copyright information detected in scan for files under the selected path.
8+
Scan must have ``--copyright`` option for Copyright Info Dashboard.
99

10-
Summary of Licenses:
10+
Summary of Copyrights:
1111

1212
- Unique holders
1313
No. of unique copyright holders detected.

docs/source/ui-reference/license-explorer.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ Title of details pane - License Expression
3030
Instances - No. of times license is detected
3131
Score - Clue's confidence about the license (Shown only for clues)
3232

33-
Matches Table
34-
User can view the match details resulting the selected license
33+
Matches Table:
34+
35+
User can view the match details resulting the selected license :
3536

3637
- ``Score``
3738
- ``Matched length``
@@ -43,8 +44,10 @@ User can view the match details resulting the selected license
4344
- ``Rule`` - User can click on the Rule to open the rule used by scancode-toolkit in browser
4445
- ``SPDX License expression``
4546

46-
File Regions Table
47-
User can view the files in which selected license was detected
47+
File Regions Table:
48+
49+
User can view the files in which selected license was detected:
50+
4851
- ``Path`` - Path of file, User can click on it to view the specific file in TableView
4952
- ``Lines`` - Specific lines in the file at which license was detected
5053
- ``Detection origin`` - Type of file

docs/source/ui-reference/table-view.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ information detected by ScanCode. A user can also see the file information (e.g.
1010
file size, etc) and package information (package type, primary language of package) that was
1111
detected.
1212

13-
The columns can be sorted as well as shown or hidden based on what the user’s
14-
preferences or using preset groups. Searching for specific clues (license names, copyrights, etc.) is also available in this view.
13+
The columns can be sorted as well as shown or hidden based on what the user
14+
preference is. Searching for specific clues (license names, copyrights, etc.)
15+
is also available in this view.
1516

1617
.. Note::
1718
The data in tableview is only available if corresponding options were enabled when performing the scan.

0 commit comments

Comments
 (0)