Skip to content

Commit 1b322b4

Browse files
committed
fix comment on NETWORK_FORMAT_VERSION
1 parent 484b53d commit 1b322b4

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/main/java/com/conveyal/r5/kryo/KryoNetworkSerializer.java

+7-5
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,13 @@ public abstract class KryoNetworkSerializer {
4545
* the serialization format itself does not change. This will ensure newer workers will not load cached older files.
4646
* We considered using an ISO date string as the version but that could get confusing when seen in filenames.
4747
*
48-
* History of Network Version (NV) changes:
49-
* nv4 2023-11-02 WebMercatorGridPointSet now contains nested WebMercatorExtents
50-
* nv3 2023-01-18 use Kryo 5 serialization format
51-
* nv2 2022-04-05
52-
* nv1 2021-04-30 stopped using r5 version string (which caused networks to be rebuilt for every new r5 version)
48+
* History of Network Version (NV) changes (in production releases):
49+
* nv3 since v7.0: switched to Kryo 5 serialization, WebMercatorGridPointSet now contains nested WebMercatorExtents
50+
* nv2 since 2022-04-05
51+
* nv1 since 2021-04-30: stopped rebuilding networks for every new r5 version, manually setting this version string
52+
*
53+
* When prototyping new features, use a unique identifier such as the branch or a commit ID, not sequential nvX ones.
54+
* This avoids conflicts when multiple changes are combined in a single production release, or some are abandoned.
5355
*/
5456
public static final String NETWORK_FORMAT_VERSION = "nv3";
5557

0 commit comments

Comments
 (0)