Skip to content

Commit 2495f9f

Browse files
committed
[docs] Update CoLic definition under documentation adn docstrings
Signed-off-by: inishchith <[email protected]>
1 parent a2de446 commit 2495f9f

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ currently available backends are:
103103
- **CoDep** extracts package and class dependencies of a Python module and serialized them as JSON structures, composed of edges and nodes, thus easing the bridging with front-end technologies for graph visualizations. It combines [PyReverse](https://pypi.org/project/pyreverse/) and [NetworkX](https://networkx.github.io/).
104104
- **CoQua** retrieves code quality insights, such as checks about line-code’s length, well-formed variable names, unused imported modules and code clones. It uses [PyLint](https://www.pylint.org/) and [Flake8](http://flake8.pycqa.org/en/latest/index.html). The tools can be activated by passing the corresponding category: `code_quality_pylint` or `code_quality_flake8`.
105105
- **CoVuln** scans the code to identify security vulnerabilities such as potential SQL and Shell injections, hard-coded passwords and weak cryptographic key size. It relies on [Bandit](https://github.com/PyCQA/bandit).
106-
- **CoLic** scans the code to extract license information. It currently supports [Nomos](https://github.com/fossology/fossology/tree/master/src/nomos) and [ScanCode](https://github.com/nexB/scancode-toolkit). They can be activated by passing the corresponding category: `code_license_nomos`, `code_license_scancode`, or `code_license_scancode_cli`.
106+
- **CoLic** scans the code to extract license & copyright information. It currently supports [Nomos](https://github.com/fossology/fossology/tree/master/src/nomos) and [ScanCode](https://github.com/nexB/scancode-toolkit). They can be activated by passing the corresponding category: `code_license_nomos`, `code_license_scancode`, or `code_license_scancode_cli`.
107107
- **CoLang** gathers insights about code language distribution of a git repository. It relies on [Linguist](https://github.com/github/linguist) and [Cloc](http://cloc.sourceforge.net/) tools. They can be activated by passing the corresponding category: `code_language_linguist` or `code_language_cloc`.
108108

109109
### How to develop a backend

bin/graal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Repositories are reached using specific backends, which are:
3737
cocom Fetch code complexity for many programming languages
3838
codep Fetch package and class dependencies of Python modules
3939
colang Fetch code language distribution
40-
colic Fetch license information
40+
colic Fetch license & copyright information
4141
coqua Fetch code quality data of Python code
4242
covuln Fetch security vulnerabilities in Python code
4343

graal/backends/core/colic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
class CoLic(Graal):
4545
"""CoLic backend.
4646
47-
This class extends the Graal backend. It gathers license information
47+
This class extends the Graal backend. It gathers license & copyright information
4848
using Nomos, Scancode or Scancode-cli
4949
5050
:param uri: URI of the Git repository

0 commit comments

Comments
 (0)