Skip to content

Commit 1197d24

Browse files
committed
docs: add descriptive module docstring for npm package handler
1 parent 930e30e commit 1197d24

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/packagedcode/npm.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
66
# See https://github.com/nexB/scancode-toolkit for support or download.
77
# See https://aboutcode.org for more information about nexB OSS projects.
8-
#
8+
9+
910
import base64
1011
import io
1112
import fnmatch
@@ -30,13 +31,13 @@
3031
import saneyaml
3132

3233
"""
33-
Handle Node.js npm packages
34-
per https://docs.npmjs.com/files/package.json
35-
"""
34+
This module helps ScanCode understand and work with Node.js (npm) packages.
3635
36+
It reads information from package.json files, such as the package name,
37+
version, dependencies, and other metadata. This helps ScanCode detect
38+
licenses, dependencies, and package details when scanning JavaScript projects.
3739
"""
38-
To check https://github.com/npm/normalize-package-data
39-
"""
40+
4041

4142

4243
SCANCODE_DEBUG_PACKAGE = os.environ.get('SCANCODE_DEBUG_PACKAGE', False)

0 commit comments

Comments
 (0)