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

Remove reference to epydoc and supporting Python 2 only #120

Closed
peterjc opened this issue Sep 22, 2017 · 4 comments
Closed

Remove reference to epydoc and supporting Python 2 only #120

peterjc opened this issue Sep 22, 2017 · 4 comments

Comments

@peterjc
Copy link

peterjc commented Sep 22, 2017

The README.rst file currently says:

Currently Implemented

 

  • Python (2 only -- Epydoc doesn't support Python 3)
  • .NET
  • Go
  • Javascript

Note epydoc is a no longer maintained Python module which has not been updated for nearly 10 years:

https://pypi.python.org/pypi/epydoc
http://epydoc.sourceforge.net/

Searching the code this is the only mention of epydoc - so I believe the README entry is out of date.

Reading the code, I think you use the Python standard library modules ast and tokenize instead, so this ought to work on Python 3 too. Indeed the .travis.yml file explicitly tests under Python 3.

@agjohnson
Copy link
Contributor

We've had a number of discussions around this, we want to avoid maintaining another AST traversal mechanism. Supporting python 2 and python 3 would require maintaining two separate ast traversal patterns, and quite frankly, even one is plenty of work -- hence epydoc.

Currently, we are using pydocstyle to parse the python code, so the documentation is out of date.

@humitos
Copy link
Member

humitos commented Dec 23, 2017

pdoc (http://pdoc.burntsushi.net/pdoc) is something that could be useful to include in this discussion.

@ericholscher
Copy link
Member

mitmproxy/pdoc#82

@AWhetter AWhetter added this to the 0.6.0 milestone Aug 4, 2018
@peterjc
Copy link
Author

peterjc commented Aug 11, 2018

Thanks - the README file is much clearer now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants