i'm writing documentation methods in python supposed available end users read through. i'm using epydoc field tags document argument based on requirements given me, , trying put parameter description in between description of method , examples of using method such:
""" description of utility does. @param utilityarguments: description of arguments @type utilityarguments: string list of examples: example1 example2 example3 """
unfortunately have not had success in finding way exclude examples type tag, , added instead of being separate. i'm trying not move parameters end of argument because feel looks neater; there way terminate tag documentation , exclude following text it?
sorry bearer of bad news, epydoc documentation disallows behavior:
fields must placed @ end of docstring, after description of object. fields may included in order.
since fields @param
, @return
markups, means things after field considered part of field (unless field).
Comments
Post a Comment