hutch_python.bug.report_bug

hutch_python.bug.report_bug(title=None, description=None, author=None, prior_commands=None, captured_output=None, **kwargs)

Report a bug from the IPython session

The purpose of this command is to collect the necessary information to later help diagnose and troubleshoot the issue. This is written as an interactive tool, but it can be used in a non-interactive way by entering the information on the call.

By the end we should have gathered:

• A brief description of the problem

• The relevant commands to the bug report

• Name of the current CONDA environment

• Any packages installed in “development” mode

• Relevant logfiles

• Name of bug report author

Parameters:

• title (str, optional) – One sentence description of the issue

• description (str, optional) – Written description of problem. If this is not provided, a text editor is launched that request the information from the user

• author (str, optional) – Name of bug report author. If not provided, this is requested from the user via command line

• prior_commands (int, optional) – Number of prior commands to capture. If this is not provided, this is requested from the user via command line.

• captured_output (str, optional) – Captured output from the command

• kwargs – Pass authentication information to post_to_github()