rename to environment

Author: matthewfeickert

src/pyhf/cli/utils.py

@@ -21,15 +21,15 @@ def cli():
     help="The location of the output file. If not specified, prints to screen.",
     default=None,
 )
-def debug(output_file):
-    debug_info = utils.debug_info()
+def environment(output_file):
+    environment_info = utils.environment_info()
 
     if output_file:
         output_file = Path(output_file)
         output_file.parent.mkdir(parents=True, exist_ok=True)
 
         with open(output_file, "w+", encoding="utf-8") as out_file:
-            out_file.write(debug_info)
-        log.debug(f"Written to {output_file}")
+            out_file.write(environment_info)
+        log.environment(f"Written to {output_file}")
     else:
-        click.echo(debug_info)
+        click.echo(environment_info)

src/pyhf/utils.py

@@ -19,7 +19,7 @@
 __all__ = [
     "EqDelimStringParamType",
     "citation",
-    "debug_info",
+    "environment_info",
     "digest",
     "options_from_eqdelimstring",
 ]
@@ -132,14 +132,14 @@ def citation(oneline=False):
     return data
 
 
-def debug_info():
+def environment_info():
     """
     Produce OS / environment information useful for filing a bug report
 
     Example:
 
         >>> import pyhf
-        >>> pyhf.utils.debug_info()
+        >>> pyhf.utils.environment_info()
 
     Returns:
         os_info (:obj:`str`): The operating system and environment information