def getdocpage()

in shelldocs/src/main/python/shelldocs.py [0:0]

• 22 lines of code
• 2 McCabe index (conditional complexity)

    def getdocpage(self):
        '''get the built document page for this function'''
        params = " ".join(self.params)
        usage = f"{self.name} {params}"
        description = "\n".join(self.description)
        if not self.returnt:
            returntext = 'Nothing'
        else:
            returntext = "\n".join(self.returnt)
        return (f"### `{self.name}`\n\n"
                "* Synopsis\n\n"
                f"```\n{usage}\n"
                "```\n\n"
                "* Description\n\n"
                f"{description}\n\n"
                "* Returns\n\n"
                f"{returntext}\n\n"
                "| Classification | Level |\n"
                "| :--- | :--- |\n"
                f"| Audience | {self.audience} |\n"
                f"| Stability | {self.stability} |\n"
                f"| Replaceable | {self.replacebool} |\n\n")