Skip to content

Commit 62ac18f

Browse files
committed
fix up test with doc8_style
Signed-off-by: swastik <swastkk@gmail.com>
1 parent df13e31 commit 62ac18f

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

docs/source/archive/gsoc/reports/2024/scancode_toolkit_swastkk.rst

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Compute summary for all detected packages.
66
| **Organization:** `AboutCode <https://aboutcode.org>`_
77
| **Project:** `Scancode Toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_
88
| **Mentee:** `Swastik Sharma (swastkk) <https://github.com/swastkk>`_
9-
| **Mentors:** `Philippe Ombredanne`_, `Ayan Sinha Mahapatra`_, `Avishrant Sharma`_, `Jonathan Yang`_, `Jay Kumar`_
9+
| **Mentors:** `Philippe Ombredanne`_, `Ayan Sinha Mahapatra`_, `Avishrant Sharma`_,
10+
`Jonathan Yang`_, `Jay Kumar`_
1011
1112
Overview
1213
--------
@@ -21,36 +22,32 @@ Implementation
2122
--------------
2223

2324
- **Added a new command-line option called** ``--package-summary``:
24-
2525
- Provides a package-level summary within a single codebase.
2626
- Involves the ``license_clarity_score`` calculation.
27-
- Populates package attributes like ``copyright``, ``holder``,
27+
- Populates package attributes like ``copyright``, ``holder``,
2828
``other_license_expression``, ``notice_text``.
2929

3030
- **The** ``--package-summary`` **option must be used with:**
31-
32-
- ``--classify``: Helps ScanCode further classify scanned files/directories into
31+
- ``--classify``: Helps ScanCode further classify scanned files/directories into
3332
categories like ``legal``, ``readme``, ``top-level``, ``manifest``.
34-
- ``--package`` or ``-p``: Detects various package manifests, lockfiles, and
35-
package-like data, assembles codebase-level packages and dependencies, and tags
33+
- ``--package`` or ``-p``: Detects various package manifests, lockfiles, and
34+
package-like data, assembles codebase-level packages and dependencies, and tags
3635
files as part of the packages.
3736

3837
- **Benefits of the change:**
39-
40-
- Allows users to obtain a more refined summary for each individual package in
38+
- Allows users to obtain a more refined summary for each individual package in
4139
a codebase.
42-
- Improves package assembly for various package ecosystems like npm, python-whl,
43-
rust, rubygems, etc. Since the package-level summary heavily depends on the package assembly,
44-
there were several scenarios where key files for top-level packages were not properly tagged.
45-
To address this, a method called ``get_top_level_resources`` was implemented. This method retrieves
46-
the resources for top-level packages, which helps in correctly tagging the key files.
40+
- Improves package assembly for various package ecosystems like npm, python-whl,
41+
rust, rubygems, etc. Since the package-level summary heavily depends on the
42+
package assembly, there were several scenarios where key files for top-level
43+
packages were not properly tagged. To address this, a method called
44+
``get_top_level_resources`` was implemented. This method retrieves the resources
45+
for top-level packages, which helps in correctly tagging the key files.
4746

4847
- **Testing:**
49-
5048
- All changes are tested through multiple full scan tests.
5149
- Validated both correct behavior and error handling.
5250

53-
5451
Linked Pull Requests
5552
--------------------
5653

@@ -68,7 +65,7 @@ Linked Pull Requests
6865
Related Issues
6966
--------------
7067

71-
.. list-table::
68+
.. list-table::
7269
:widths: 10 60 30
7370
:header-rows: 1
7471

@@ -135,7 +132,8 @@ I would like to thank my mentors:
135132
- `Jonathan Yang`_
136133

137134
Weekly Status calls were greatly helpful and those special 1:1 calls with
138-
`Ayan Sinha Mahapatra`_ and `Philippe Ombredanne`_ were so amazing. Thank you for your time and your patience!
135+
`Ayan Sinha Mahapatra`_ and `Philippe Ombredanne`_ were so amazing.
136+
Thank you for your time and your patience!
139137

140138

141139
.. _Philippe Ombredanne: https://github.com/pombredanne

docs/source/contributing.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
Contributing to AboutCode
33
#########################
44

5-
We welcome you and your interest in contributing to open source software! AboutCode is always looking for enthusiatic contributors and we are happy to help with any questions or comments. Here a few resources to get started:
5+
We welcome you and your interest in contributing to open source software! AboutCode
6+
is always looking for enthusiatic contributors and we are happy to help with any questions
7+
or comments. Here a few resources to get started:
68

79
1) Take a look through our public repos here: https://github.com/aboutcode-org/
810
* Find one you are interested in and check out its open **Issues**
9-
2) If you have specific questions browse through our documentation here: https://aboutcode.readthedocs.io/en/latest/
11+
2) If you have specific questions browse through our documentation here:
12+
https://aboutcode.readthedocs.io/en/latest/
1013
* Depending on the project, there may be a separate ReadTheDocs website
11-
* Not finding what you were looking for or still have questions? Open an issue on the relevant repository or ask directly via Gitter or Slack
14+
* Not finding what you were looking for or still have questions?
15+
Open an issue on the relevant repository or ask directly via Gitter or Slack
1216

1317
You can always interact with the AboutCode community on Gitter_ and Slack_.
1418

0 commit comments

Comments
 (0)