[Git][reproducible-builds/diffoscope][master] Document that run_diffoscope should not be considered a stable API.

[Chris Lamb]

Chris Lamb pushed to branch master at Reproducible Builds / diffoscope


Commits:
76319f96 by Chris Lamb at 2019-06-14T15:15:36Z
Document that run_diffoscope should not be considered a stable API.

- - - - -


1 changed file:

- diffoscope/main.py


Changes:

=====================================
diffoscope/main.py
=====================================
@@ -598,6 +598,12 @@ def maybe_set_limit(config, parsed_args, key):
 
 
 def run_diffoscope(parsed_args):
+    """
+    (This should not be considered a stable API suitable for external
+    consumption, and the lack of configuration of globals may result in
+    unpredictable behaviour.)
+    """
+
     ProfileManager().setup(parsed_args)
     PresenterManager().configure(parsed_args)
     logger.debug("Starting diffoscope %s", VERSION)



View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/commit/76319f96d4634786d399e8619daf0db70cec6da7

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/diffoscope/commit/76319f96d4634786d399e8619daf0db70cec6da7
You're receiving this email because of your account on salsa.debian.org.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20190614/4c0b4b7a/attachment.html>