From 481935da7bc94fd519bc7a9f9f1555636d6dc55f Mon Sep 17 00:00:00 2001 From: Vijai Kumar S Date: Tue, 11 Jun 2024 17:57:54 +0530 Subject: [PATCH] Include some rudimentary documentation in lib3mf_version_update.py --- lib3mf_version_update.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/lib3mf_version_update.py b/lib3mf_version_update.py index 7b780bd76..bcae19022 100644 --- a/lib3mf_version_update.py +++ b/lib3mf_version_update.py @@ -1,3 +1,22 @@ +''' + +@author: Vijai Kumar Suriyababu + +A simple script to update the lib3mf version number in all the necessary places. +Its run as follows + +python lib3mf_version_update.py 2.3.1 2.3.2 + +First argument is current version number and the second one is new version number + +It does the following +* Update version number in lib3mf.xml and generate bindings using ACT +* Patch the Python bindings +* Update the CMakeLists.txt +* Update all the docs, readme's and python, CPP examples and so on + +''' + import os import argparse import re