search

nucleic / enaml

Declarative User Interfaces for Python
http://enaml.readthedocs.io/en/latest/
Other
1.52k stars 130 forks source link

Tutorials are incomplete #506

Open skorokithakis opened 1 year ago

skorokithakis commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Maybe something related to #460 ?

MatthieuDartiailh commented 1 year ago

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.