fml_doc_gen.write_docstring_to_file

Functions

write_docstring_to_file(→ None)

Writes the generated docstring to a specified output file.

Module Contents

fml_doc_gen.write_docstring_to_file.write_docstring_to_file(docstring: str, output_file: str = None) → None[source]

Writes the generated docstring to a specified output file.

Parameters:

  • docstring (str) – The docstring to be written to the file.

  • output_file (str) – The path to the output file.

Returns:

This function does not return anything.

Return type:

None

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’