[
https://issues.apache.org/jira/browse/BEAM-693?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15606307#comment-15606307
]
Ahmet Altay commented on BEAM-693:
----------------------------------
Thank you for looking at this. We can defer the other options for documentation
to the https://issues.apache.org/jira/browse/BEAM-817 . Let's fix the
instruction for pydoc in the readme.
According to [1] develop has the advantage if you are making frequent code
changes. Most of our users would not change the code so install is a better
option. (This also helps because we recommend install for using in other parts
of the readme.)
Readme should be updated to say something along these lines:
"""
Make sure you installed the package first, if not run 'python setup.py install'
then run pydoc with 'pydoc -p 8888'
...
"""
Marco, would you like to make that change?
[1]
http://stackoverflow.com/questions/19048732/python-setup-py-develop-vs-install
> pydoc is not working
> --------------------
>
> Key: BEAM-693
> URL: https://issues.apache.org/jira/browse/BEAM-693
> Project: Beam
> Issue Type: Bug
> Components: sdk-py
> Reporter: Ahmet Altay
> Priority: Minor
>
> Repro:
> Start the pydoc server (pydoc -p 8888) and navigate to the apache_beam root:
> http://localhost:8888/apache_beam.html
> Following errors are shown instead of the actual documentation:
> problem in apache_beam - <type 'exceptions.ImportError'>: No module named avro
> problem in apache_beam - <type 'exceptions.ImportError'>: cannot import name
> coders
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
