def write_doc()

in build/gen_py_api_docs.py [0:0]

• 19 lines of code
• 6 McCabe index (conditional complexity)

def write_doc(filename, f):
    """
    Write the documentation for a Function `f` to `filename`
    """
    with open(filename, "w") as docfile:

        # Write the title and shortdoc
        docfile.write("## " + f.name + "\n")
        docfile.write(f.shortdoc + "\n")

        # Write out the signature
        docfile.write("```\n")
        docfile.write(f.name + "(\n")
        for param in f.params:
            if param.has_default:
                docfile.write("    " + param.name + " = " + str(param.default) + ",\n")
            else:
                docfile.write("    " + param.name + ",\n")
        docfile.write(")\n")
        docfile.write("```\n")

        # Write out the list of params with their docs
        docfile.write("### Params:\n")
        for param in f.params:
            docfile.write("#### " + param.name + "\n")
            if param.has_default:
                docfile.write("*default: `" + str(param.default) + "`*\n\n")

            docfile.write(param.get_clean_doc() + "\n\n")