Skip to content

Commit 3522153

Browse files
Misc doc changes and test fixes
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent afa2d4c commit 3522153

8 files changed

Lines changed: 10 additions & 204 deletions

File tree

docs/source/contribute/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,3 @@
1111
gsoc17_final_report
1212
gsoc19_final_report
1313
gsoc21_final_report
14-
long_running_issues

docs/source/contribute/long_running_issues.rst

Lines changed: 0 additions & 181 deletions
This file was deleted.

docs/source/explanations/license-detection-reference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ We now have a new codebase level attribute ``license_detections`` which has Uniq
303303
license detection across the codebase, in both packages and resources. They are
304304
linked by a common attribute ``identifier`` containing the ``license_expression``
305305
and a UUID generated from the match content. The match level data is only present
306-
at the resource level if needed, to look at details.
306+
at the resource level if needed, to look at details.
307307

308308
New codebase level attribute::
309309

@@ -684,7 +684,7 @@ LicenseDetection Data
684684
This is referencing by LicenseDetections objcts, and has one or multiple
685685
license matches. This is linked to the resource level detections through
686686
an ``identifier`` attribute present in both resource and codebase level
687-
detections. See the `unique license detections section <license_detections_unique>`_
687+
detections. See the `unique license detections section <license_detections_unique>`_
688688
above for more details on this.
689689

690690
There could be a list of ambiguous detections as a summary to review.

docs/source/getting-started/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ operating system by going to the `project releases page <https://github.com/nexB
123123

124124
For example, Version 30.0.1 archive can be obtained from
125125
`Toolkit release 30.0.1 <https://github.com/nexB/scancode-toolkit/releases/tag/v30.0.1>`_
126-
under assets options.
126+
under assets options.
127127

128128
.. Note::
129129

@@ -347,7 +347,7 @@ the standard Python package management tool.
347347
Apple M1 chips, as some non-native dependencies does not have pre-built wheels
348348
for ARM (like py-ahocorasick, intbitset). See :ref:`system_requirements` for
349349
more information. See related issues for more info:
350-
350+
351351
- `Fallback pure-python deps <https://github.com/nexB/scancode-toolkit/issues/3210>`_
352352
- `pip install failing on M1 <https://github.com/nexB/scancode-toolkit/issues/3205>`_
353353

docs/source/getting-started/newcomer.rst

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -252,17 +252,6 @@ Good First Issues
252252
A `good first issue <https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue>`_
253253
means it's recommended for people who haven't contributed to Scancode Toolkit before.
254254

255-
#. Refer the detailed documentation for :ref:`good_first_issue`.
256-
#. :ref:`good_1st_issue_links` for Good First issues are also compiled.
257-
#. :ref:`good_1st_issue_understand_b4_solving`
258-
#. :ref:`good_1st_issue_workflow`
259-
260-
A `first timers only <https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only>`_
261-
issue means we've worked to make it more legible to folks who either **haven't contributed to our
262-
codebase before, or even folks who haven't contributed to open source before**.
263-
264-
Refer the detailed documentation for :ref:`first_timers_only`.
265-
266255
.. _newcomer_add_functionalirty:
267256

268257
Add new Functionality/Enhancement to ScanCode
@@ -324,14 +313,13 @@ If you want to participate in any of the two programs:
324313
Then:
325314

326315
#. Keep an eye out for Application Timelines.
327-
#. Solve multiple of these :ref:`good_first_issue` to demonstrate your skills,
316+
#. Solve multiple of these :ref:`newcomer_good_first_issue` to demonstrate your skills,
328317
and improve your chances of selection.
329318
#. Refer the Projects Ideas list for details on tentative projects.
330319

331-
- :ref:`GSoC2019`
332-
- :ref:`GSoD2019`
320+
- `GSoC2023 <https://github.com/nexB/aboutcode/wiki/GSOC-2023>`_
333321

334-
#. Remain active in Gitter and talk with the organization mentors well ahead of the deadlines.
322+
#. Remain active in Element and talk with the organization mentors well ahead of the deadlines.
335323
#. Select projects according to your skills and finalize project proposals.
336324
#. Discuss your proposals extensively with corresponding mentors.
337325
#. Apply for the Programs well before the Deadline.

docs/source/how-to-guides/add_new_license.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ And more attributes which are not mandatory but nice to have always (if applicab
5454
We want to use `minimum_coverage` when there are other licenses which are very similar
5555
and we want to make sure we match correctly these licenses, and `notes` for interesting
5656
cases of licenses with descriptions to help identify origin, similarities to other licenses,
57-
notes about the SPDX keys and others.
57+
notes about the SPDX keys and others.
5858

5959
Some URLs:
6060

docs/source/how-to-guides/add_new_license_detection_rule.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ might have a filename: `mit_and_apache-2.0_10.RULE`.
3434

3535
Save your rule text in this file, if there are specific words like company names,
3636
projects or other, it is better to have rules with and without these so we have
37-
better detection.
37+
better detection.
3838

3939
For a simple `mit AND apache-2.0` license expression detection, here is an example
4040
rule file::

docs/source/how-to-guides/install_new_license_plugin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Then you can define a test class and call the ``build_tests`` method defined in
139139
clazz=TestLicenseDataDriven1, regen=scancode_config.REGEN_TEST_FIXTURES)
140140

141141
The ``tests/data`` directory contains a file for each license:
142-
a license text file with a YAML frontmatter specifying the expected license expression
142+
a license text file with a YAML frontmatter specifying the expected license expression
143143
from the test.
144144

145145
Finally, install the plugin and run the test:

0 commit comments

Comments
 (0)