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

Outdated example code #454

Closed
1 of 2 tasks
sameshl opened this issue Feb 26, 2020 · 2 comments
Closed
1 of 2 tasks

Outdated example code #454

sameshl opened this issue Feb 26, 2020 · 2 comments

Comments

@sameshl
Copy link
Member

sameshl commented Feb 26, 2020

I'm submitting a

  • bug report.
  • feature request.

Current Behaviour:

Lot of code for the doc_gen.py files from the hydrus repo in the ./examples folder seem outdated.
For eg, The way the status codes is defined here is wrong. It get interpreted in the expectsHeader section instead of possibleStatus section. The correct way would have been to use the HydraStatus or HydraError class.

Screenshot from 2020-02-23 22-26-11

Expected Behaviour:

The expected result should have been that it gets added to the possibleStatus section.
Screenshot from 2020-02-26 22-06-05

Steps to reproduce:

run python3 hydrus/examples/drones/doc_gen.py and examine the generated api doc and you would be able to find the above issues.

Do you want to work on this issue?

Yes

@sameshl sameshl changed the title Outdated example code due to Outdated example code Feb 28, 2020
@n1khilmane
Copy link

After running the python3 hydrus/examples/drones/doc_gen.py, I am getting this error, how should i fix it.
File "doc_gen.py", line 3, in <module> from hydra_python_core.doc_writer import HydraDoc, HydraClass, HydraClassProp, HydraClassOp ModuleNotFoundError: No module named 'hydra_python_core'

@sameshl
Copy link
Member Author

sameshl commented Feb 28, 2020

@n1khilmane Have you installed all the dependencies in your virtual envirnoment while setting up the project before running python3 hydrus/examples/drones/doc_gen.py?

If not, in the root directory of this project:
To create virtual env: python3 -m venv venv
To activate the env: source venv/bin/activate
To install the required dependencies: pip3 install -r requirements.txt

Now run, python3 hydrus/examples/drones/doc_gen.py.

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

3 participants