Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please parse and display @params and @returns of methods separate from description text #73

Closed
brettnolan opened this issue Oct 27, 2015 · 1 comment

Comments

Projects
None yet
2 participants
@brettnolan
Copy link

commented Oct 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:

@staticmethod
def version_str(version):
    """
    Retrieves the current version string of the software loaded on the DUT.
    @param version - A dictionary containing version information
    @return: Return a string form of the version.
    """

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.

@BurntSushi

This comment has been minimized.

Copy link
Contributor

commented Oct 27, 2015

Dupe of #59.

@BurntSushi BurntSushi closed this Oct 27, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.