Skip to content

Commit 176b463

Browse files
committed
Fixed "Trailing whitespace" and "Line too long" warning by doc8
1 parent 1b9d682 commit 176b463

2 files changed

Lines changed: 18 additions & 14 deletions

File tree

docs/source/aboutcode-toolkit/reference.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Options
8787

8888
Users can use the following in the template to get the vartext:
8989
{{ variables['title'] }}
90-
{{ variables['header'] }}
90+
{{ variables['header'] }}
9191

9292
--verbose
9393

@@ -98,9 +98,12 @@ Options
9898
The following data are passed to jinja2 and, therefore, can be used for a custom template:
9999
* about object: the about objects
100100
* common_licenses: a common license keys list in licenses.py
101-
* license_key_and_context: a dictionary list with license_key as a key and license text as the value
102-
* license_file_name_and_key: a dictionary list with license file name as a key and license key as the value
103-
* license_key_to_license_name: a dictionary list with license key as a key and license file name as the value
101+
* license_key_and_context: a dictionary list with license_key as a key
102+
and license text as the value
103+
* license_file_name_and_key: a dictionary list with license file name as
104+
a key and license key as the value
105+
* license_key_to_license_name: a dictionary list with license key as a key
106+
and license file name as the value
104107

105108

106109
check
@@ -261,7 +264,7 @@ Options
261264
The above command will only inventory the ABOUT files which have the "license_expression: gpl-2.0"
262265

263266
-f, --format [json|csv]
264-
267+
265268
Set OUTPUT file format. [default: csv]
266269

267270
$ about inventory -f json LOCATION OUTPUT
@@ -299,7 +302,7 @@ The multiple licenses support format for ABOUT files are by "grouping" with the
299302
file: mit.LICENSE
300303

301304

302-
Multiple license_file support
305+
Multiple license_file support
303306
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
304307
To support multiple license file for a license, the correct format is to separate by comma
305308

@@ -348,7 +351,8 @@ transform
348351

349352
Purpose
350353
^^^^^^^
351-
Transform the CSV file at LOCATION by applying renamings, filters and checks and write a new CSV to OUTPUT.
354+
Transform the CSV file at LOCATION by applying renamings, filters and checks
355+
and write a new CSV to OUTPUT.
352356

353357
Options
354358
^^^^^^^
@@ -365,7 +369,7 @@ Options
365369

366370
Show configuration file format help and exit.
367371
This option will print out examples of the the YAML configuration file.
368-
372+
369373
Keys configuration are: `field_renamings`, `required_fields` and `field_filters`
370374

371375
$ about transform --help-format

docs/source/aboutcode-toolkit/specification.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ A field name can contain only these US-ASCII characters:
106106
- Field names are not case sensitive. For example, "HOMEPAGE_URL" and "HomePage_url"
107107
represent the same field name.
108108

109-
- A field name must start at the beginning of a new line. No spaces is allowed in the
110-
field name. It can be followed by one or more spaces that must be ignored.
109+
- A field name must start at the beginning of a new line. No spaces is allowed in the
110+
field name. It can be followed by one or more spaces that must be ignored.
111111
These spaces are commonly used to improve the readability of an ABOUT file.
112112

113113

@@ -158,7 +158,7 @@ name syntax or invalid content. Tools should report additional validation error
158158
details. The validation process should check that each field name is
159159
syntactically correct and that fields contain correct values according to its
160160
concise, common sense definition in this specification. For certain fields,
161-
additional and specific validations are relevant such as URL validation,
161+
additional and specific validations are relevant such as URL validation,
162162
path resolution and verification, and so forth. Tools should
163163
report a warning for present fields that do not have any value.
164164

@@ -230,7 +230,7 @@ Referencing the file or directory documented by an ABOUT file
230230

231231
An ABOUT file documents one file or directory. The mandatory "about_resource"
232232
field reference the documented file or directory. The value of the
233-
"about_resource" field is the name or path of the referenced file or directory.
233+
"about_resource" field is the name or path of the referenced file or directory.
234234

235235
A tool processing an ABOUT file must report an error if this field is missing.
236236

@@ -404,15 +404,15 @@ These fields support checksums (such as SHA1 and MD5)commonly provided with
404404
downloaded archives to verify their integrity. A tool can optionally use these
405405
to verify the integrity of a file documented by an ABOUT file.
406406

407-
- checksum_md5: MD5 for the file documented by this ABOUT file in the
407+
- checksum_md5: MD5 for the file documented by this ABOUT file in the
408408
"about_resource" field.
409409

410410
- checksum_sha1: SHA1 for the file documented by this ABOUT file in the
411411
"about_resource" field.
412412

413413
- checksum_sha256: SHA256 for the file documented by this ABOUT file in the
414414
"about_resource" field.
415-
415+
416416
Some examples::
417417

418418
checksum_md5: f30b9c173b1f19cf42ffa44f78e4b96c

0 commit comments

Comments
 (0)