Skip to content

Commit b8bf667

Browse files
committed
Adjust the formatting of the bulletin forms to avoid quoting #2246
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 56d19e9 commit b8bf667

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

src/licensedcode/README.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,43 @@ perform scans and provide precise license conclusions.
99
Key Functionality
1010
-----------------
1111

12-
* License Rule Management: Stores and manages a large collection of
13-
license rules, including full texts, snippets, and regular expressions.
12+
- License Rule Management: Stores and manages a large collection of
13+
license rules, including full texts, snippets, and regular expressions.
1414

15-
* Pattern Matching: Implements sophisticated algorithms for matching
16-
detected code against known license patterns and texts.
15+
- Pattern Matching: Implements sophisticated algorithms for matching
16+
detected code against known license patterns and texts.
1717

18-
* License Detection Logic: Contains the core logic for processing scan
19-
input, applying rules, and determining the presence and type of
20-
licenses.
18+
- License Detection Logic: Contains the core logic for processing scan
19+
input, applying rules, and determining the presence and type of
20+
licenses.
2121

22-
* Rule-based Detection: Utilizes a robust system of rules to identify
23-
licenses even when only fragments or variations of license texts are
24-
present.
22+
- Rule-based Detection: Utilizes a robust system of rules to identify
23+
licenses even when only fragments or variations of license texts are
24+
present.
2525

26-
* License Expression Parsing: Supports the parsing and interpretation of
27-
complex license expressions (e.g., "MIT AND Apache-2.0").
26+
- License Expression Parsing: Supports the parsing and interpretation of
27+
complex license expressions (e.g., "MIT AND Apache-2.0").
2828

2929

3030
How It Works (High-Level)
3131
-------------------------
3232

3333
At a high level, the `licensedcode`` module operates by:
3434

35-
1. Loading License Data: It initializes by loading a curated set of
36-
license texts, short license identifiers, and detection rules from its
37-
internal data store.
35+
1. Loading License Data: It initializes by loading a curated set of
36+
license texts, short license identifiers, and detection rules from its
37+
internal data store.
3838

39-
2. Scanning Input: When ScanCode processes a file or directory, the
40-
content is converted into an internal representation (a "query").
39+
2. Scanning Input: When ScanCode processes a file or directory, the
40+
content is converted into an internal representation (a "query").
4141

42-
3. Applying Rules: The module then applies its extensive set of rules and
43-
patterns to the input content through a multi-stage pipeline, looking
44-
for matches.
42+
3. Applying Rules: The module then applies its extensive set of rules and
43+
patterns to the input content through a multi-stage pipeline, looking
44+
for matches.
4545

46-
4. Reporting Detections: Upon successful matches, it reports the
47-
identified licenses, their confidence levels, and the exact locations
48-
(lines, characters) where they were found.
46+
4. Reporting Detections: Upon successful matches, it reports the
47+
identified licenses, their confidence levels, and the exact locations
48+
(lines, characters) where they were found.
4949

5050
For a more in-depth understanding of the underlying technical principles
5151
and the detection pipeline, please refer to the sections below.

0 commit comments

Comments
 (0)