Object .example() method may be confusing

expectedparrot / edsl

Design, conduct and analyze results of AI-powered surveys and experiments. Simulate social science and market research with large numbers of AI agents and LLMs.

https://docs.expectedparrot.com

MIT License

97 stars 14 forks source link

Object .example() method may be confusing #402

Open rbyh opened 2 months ago

rbyh commented 2 months ago

We are telling people to run the example() method to see examples of objects but this does NOT show the user:

Which parameters are not/required
A template for actually creating an object

We should consider ways of expressing this information at the same time eg the user does not need to enter the question_type to create a question object:

johnjosephhorton commented 2 months ago

Agreed - two thoughts.

We should encourage people to use help(X) to get our docs in context (and include URL to docs)
If we get the 'code' method working for all objects, we can also easily show how that object is constructed