Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upPlease parse and display @params and @returns of methods separate from description text #73
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
brettnolan commentedOct 27, 2015
It would be really nice if the pdoc would parse and display thinks like the @params and @returns separately (and appropriately) from the rest of the description content.
So for instance, if my descriptor looked like:
It would show separate Parameters and Returns sections in the output like:
def version_str(version)
Retrieves the current version string of the software loaded on the DUT.
Parameters
version A dictionary containing version information
Returns
Return a string form of the version.