Skip to content

Commit 6597d24

Browse files
authored
Match description field names to definition (#806)
In the description, the field names should match the names defined in the proto definition for better discoverability and less mental load. When trying to reading and understand the protocol it should be possible to look for the description of a field by searching the name of such a field in the document. However, at the moment, if a reader would like to find out more about the field `encryption_password_token` they should scroll down until they find `enc pw token` and a little extra effort is needed to ensure that this the same as `encryption_password_token`. By using the same name a reader can search and find the field in the document without extra scrolling.
1 parent dec3932 commit 6597d24

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Diff for: specs/bep-v1.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -288,16 +288,16 @@ the folder.
288288
The **label** field contains the folder label, the human readable name of
289289
the folder.
290290

291-
The **read only** field is set for folders that the device will accept no
291+
The **read_only** field is set for folders that the device will accept no
292292
updates from the network for.
293293

294-
The **ignore permissions** field is set for folders that the device will not
294+
The **ignore_permissions** field is set for folders that the device will not
295295
accept or announce file permissions for.
296296

297-
The **ignore delete** field is set for folders that the device will ignore
297+
The **ignore_delete** field is set for folders that the device will ignore
298298
deletes for.
299299

300-
The **disable temp indexes** field is set for folders that will not dispatch
300+
The **disable_temp_indexes** field is set for folders that will not dispatch
301301
and do not wish to receive progress updates about partially downloaded files
302302
via Download Progress messages.
303303

@@ -326,23 +326,23 @@ device and folder. The following values are valid:
326326
:1: Compression disabled. No compression is used on any message.
327327
:2: Compress always. Metadata messages as well as Response messages are compressed.
328328

329-
The **cert name** field indicates the expected certificate name for this
329+
The **cert_name** field indicates the expected certificate name for this
330330
device. It is commonly blank, indicating to use the implementation default.
331331

332-
The **max sequence** field contains the highest sequence number of the files
332+
The **max_sequence** field contains the highest sequence number of the files
333333
in the index. See :ref:`deltaidx` for the usage of this field.
334334

335335
The **introducer** field is set for devices that are trusted as cluster
336336
introducers.
337337

338-
The **index id** field contains the unique identifier for the current set of
338+
The **index_id** field contains the unique identifier for the current set of
339339
index data. See :ref:`deltaidx` for the usage of this field.
340340

341-
The **skip introduction removals** field signifies if the remote device has
341+
The **skip_introduction_removals** field signifies if the remote device has
342342
opted to ignore introduction removals for the given device. This setting is
343343
copied across as we are being introduced to a new device.
344344

345-
The **enc pw token** field contains a token derived from the password, that is
345+
The **encryption_password_token** field contains a token derived from the password, that is
346346
used to encrypt data sent to this device. If the device is the same as the
347347
device sending the message, it signifies that the device itself has encrypted
348348
data that was encrypted with the given token. It is empty or missing if there is
@@ -465,7 +465,7 @@ The **invalid** field is set when the file is invalid and unavailable for
465465
synchronization. A peer MAY set this bit to indicate that it can temporarily
466466
not serve data for the file.
467467

468-
The **no permissions** field is set when there is no permission information
468+
The **no_permissions** field is set when there is no permission information
469469
for the file. This is the case when it originates on a file system which
470470
does not support permissions. Changes to only permission bits SHOULD be
471471
disregarded on files with this bit set. The permissions bits MUST be set to
@@ -534,7 +534,7 @@ the other device SHOULD ensure that the transmitted block matches the
534534
requested hash. The other device MAY reuse a block from a different file and
535535
offset having the same size and hash, if one exists.
536536

537-
The **from temporary** field is set to indicate that the read should be
537+
The **from_temporary** field is set to indicate that the read should be
538538
performed from the temporary file (converting name to it's temporary form)
539539
and falling back to the non temporary file if any error occurs. Knowledge of
540540
contents of temporary files comes from DownloadProgress messages.
@@ -627,7 +627,7 @@ The **updates** field is a list of progress update messages.
627627
Fields (FileDownloadProgressUpdate Message)
628628
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
629629

630-
The **update type** indicates whether the update is of type **append (0)**
630+
The **update_type** indicates whether the update is of type **append (0)**
631631
(new blocks are available) or **forget (1)** (the file transfer has
632632
completed or failed).
633633

@@ -637,7 +637,7 @@ this update is being sent.
637637
The **version** message defines the version of the file for which this
638638
update is being sent.
639639

640-
The **block indexes** field is a list of positive integers, where each
640+
The **block_indexes** field is a list of positive integers, where each
641641
integer represents the index of the block in the FileInfo message Blocks
642642
array that has become available for download.
643643

0 commit comments

Comments
 (0)