fml_doc_gen.write_docstring_to_file
===================================

.. py:module:: fml_doc_gen.write_docstring_to_file


Functions
---------

.. autoapisummary::

   fml_doc_gen.write_docstring_to_file.write_docstring_to_file


Module Contents
---------------

.. py:function:: write_docstring_to_file(docstring: str, output_file: str = None) -> None

   Writes the generated docstring to a specified output file.

   :param docstring: The docstring to be written to the file.
   :type docstring: str
   :param output_file: The path to the output file.
   :type output_file: str

   :returns: This function does not return anything.
   :rtype: None

   .. rubric:: Examples

   >>> docstring = """Parameters
   ----------
   a : int
   b : int

   :returns: * *int*
             * *"""*
             * *>>> output_file = 'docstring_output.txt'*
             * *>>> write_docstring_to_file(docstring, output_file)*
             * *# This writes the docstring to 'docstring_output.txt'*