Why are the functions in mitiq/interface/conversions.py missing from the API-doc?

[purva-thakre]

I have been working on understanding how accept_qprogram_and_validate works. This made me realize the functions in mitiq/interface/conversions.py are missing from the Interface section of the API-doc.

Some of the functions used by accept_qprogram_and_validate are also missing their docstrings. This makes it difficult to understand what the goal of a particular function is.

[purva-thakre]

Plus, I think the docs section on Frontends and Backends needs to be updated with information about unsupported circuit types.

(if I am reading the docstring of the following function correctly: a user can define their own circuit converter)

mitiq/mitiq/interface/conversions.py

Lines 37 to 49 in bf82e84

	def register_mitiq_converters(
	package_name: str,
	*,
	convert_to_function: Callable[[cirq.Circuit], Any],
	convert_from_function: Callable[[Any], cirq.Circuit],
	) -> None:
	"""Registers converters for unsupported circuit types.
	Args:
	package_name: A quantum circuit module name that is not currently
	supported by Mitiq. Note: this name should be the same as the
	return from "circuit".__module__.
	See mitiq.SUPPORTED_PROGRAM_TYPES.

[natestemen]

Good point, I don't think we've added public facing documentation for this feature! Care to open an issue?

[natestemen]

My rationalization for the status quo is that the API-doc is primarily for Mitiq users, and Mitiq users should basically never user any of the functions in mitiq/interface/conversions.py.

[purva-thakre]

well, if we create an issue for the register_mitiq_converters function, we should also add all the functions used by the converter. WDYT?

[jordandsullivan]

Plan to test out which functions are needed by an end user who wants to register a converter in this way and add those to API doc.

[purva-thakre]

Resolved in favor of #2409