Skip to content

Commit

Permalink
Add minor fixes in workbench docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
  • Loading branch information
AyanSinhaMahapatra committed Oct 16, 2023
1 parent 6c92d66 commit be37218
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/source/ui-reference/chart-summary-view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

The attributes are a subset of the columns displayed in the table view, and can be
Expand Down
6 changes: 3 additions & 3 deletions docs/source/ui-reference/copyright-info-dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
:index:`Copyright Info Dashboard`
===================================

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

Summary of Licenses:
Summary of Copyrights:

- Unique holders
No. of unique copyright holders detected.
Expand Down
11 changes: 7 additions & 4 deletions docs/source/ui-reference/license-explorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ Title of details pane - License Expression
Instances - No. of times license is detected
Score - Clue's confidence about the license (Shown only for clues)

Matches Table
User can view the match details resulting the selected license
Matches Table:

User can view the match details resulting the selected license :

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

File Regions Table
User can view the files in which selected license was detected
File Regions Table:

User can view the files in which selected license was detected:

- ``Path`` - Path of file, User can click on it to view the specific file in TableView
- ``Lines`` - Specific lines in the file at which license was detected
- ``Detection origin`` - Type of file
Expand Down
5 changes: 3 additions & 2 deletions docs/source/ui-reference/table-view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ information detected by ScanCode. A user can also see the file information (e.g.
file size, etc) and package information (package type, primary language of package) that was
detected.

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

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

0 comments on commit be37218

Please sign in to comment.