From da4ae24440c7815492a6f59d7416725dea0cee37 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Fri, 17 Dec 2021 12:23:20 +0000 Subject: [PATCH] Document use of *local* outfitting.csv instead of FDevIDs version That's in collate.py and coriolis.py docstrings. --- collate.py | 5 +++++ coriolis.py | 9 ++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/collate.py b/collate.py index d789a6c5..3ab5224b 100755 --- a/collate.py +++ b/collate.py @@ -5,6 +5,11 @@ Collate lists of seen commodities, modules and ships from dumps of the Companion Note that currently this will only work with the output files created if you run the main program from a working directory that has a `dump/` directory, which causes a file to be written per CAPI query. + +This script also utilise the file outfitting.csv. As it both reads it in *and* +writes out a new copy a local copy, in the root of the project structure, is +used for this purpose. If you want to utilise the FDevIDs/ version of the +file, copy it over the local one. """ import csv diff --git a/coriolis.py b/coriolis.py index 5ce76a29..0afb16e5 100755 --- a/coriolis.py +++ b/coriolis.py @@ -1,5 +1,12 @@ #!/usr/bin/env python3 -"""Build ship and module databases from https://github.com/EDCD/coriolis-data/ .""" +""" +Build ship and module databases from https://github.com/EDCD/coriolis-data/ . + +This script also utilise the file outfitting.csv. Due to how collate.py +both reads and writes to this file a local copy is used, in the root of the +project structure, is used for this purpose. If you want to utilise the +FDevIDs/ version of the file, copy it over the local one. +""" import csv