From 039f954e7082e586c8a6dc3c223e886e474be785 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Sat, 28 Jan 2023 15:31:47 +0100 Subject: [PATCH] docs: Add some doc string to the scripts --- scripts/lock2nix.py | 6 ++++++ scripts/pubspec2lock.py | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/scripts/lock2nix.py b/scripts/lock2nix.py index ff193ee..9bbda84 100644 --- a/scripts/lock2nix.py +++ b/scripts/lock2nix.py @@ -1,3 +1,9 @@ +''' +This script generates a .nix file containing all dependencies specified in the +special lock file. The .nix file also contains the derivation "pubCache", which can +be used as the path in the PUB_CACHE environment variable. +''' + import sys import yaml import urllib.parse diff --git a/scripts/pubspec2lock.py b/scripts/pubspec2lock.py index dc6ac44..fb92f13 100644 --- a/scripts/pubspec2lock.py +++ b/scripts/pubspec2lock.py @@ -1,3 +1,9 @@ +''' +Takes a Dart pubspec.lock file as input and outputs a specialized lock file +that contains archive URLs and sha256 hashes for nix. Only useful in combination +with lock2nix.py. +''' + import sys import subprocess import urllib