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

Tutorials are incomplete #506

Open
skorokithakis opened this issue Sep 12, 2022 · 5 comments
Open

Tutorials are incomplete #506

skorokithakis opened this issue Sep 12, 2022 · 5 comments

Comments

@skorokithakis
Copy link

I just downloaded Enaml and am trying to follow the Person tutorial, but it's incomplete. It doesn't tell me how to name the files or how to run them, so I just get an error like this:

14:34:02 $ enaml-run lala.enaml
Could not find component 'Main'

In my opinion, tutorials should assume zero knowledge on the part of the reader, so the tutorial should tell me the names of the files and the command I need to see the UI.

@MatthieuDartiailh
Copy link
Member

The tutorials are a bit different from the other examples in that one should run python hello_world.py to run the hello world example rather than going through enaml-run. This part has not been edited in a long time (before I took over the maintenance I think) and I missed the issue. I am sorry for the disagreement.

If you feel so inclined feel free to make a PR, otherwise I will do my best to update the docs ASAP.

@skorokithakis
Copy link
Author

skorokithakis commented Sep 12, 2022

I'd make a PR, but I don't know how to run the example :P I mean, I don't know what the filenames should be.

@MatthieuDartiailh
Copy link
Member

As mentionned in my previous comment to run hello_world call, with python, hello_world.py, person.py for the person tutorial and employee.py for the employee tutorial.

@Kochise
Copy link

Kochise commented Oct 2, 2022

Maybe something related to #460 ?

@MatthieuDartiailh
Copy link
Member

#460 will make it easier to run the examples but does not address the documentation issue though.

I merged it nonetheless since it is an improvement over the status quo.

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