Change ExecuteModel to model in Python docs about roadrunner HOT 8 CLOSED

What is the current status of this method?

from roadrunner.

Its not a method, which is what is confusing in the docs. Its a class but
when someone sees it in the docs they think that have to call
executemethod. etc.

Is there someway to remove this word from the docs?

H

On Mon, Aug 31, 2015 at 3:44 PM, Kiri Choi [email protected] wrote:

What is the current status of this method?

—
Reply to this email directly or view it on GitHub
#10 (comment).

from roadrunner.

Well, ExecuutableModel is the class name, which you get an instance of by calling rr.model. Not sure what we can do, python docs are always in the format ClassName.MethodName

On August 31, 2015 5:46:07 PM PDT, Herbert Sauro [email protected] wrote:

Its not a method, which is what is confusing in the docs. Its a class
but
when someone sees it in the docs they think that have to call
executemethod. etc.

Is there someway to remove this word from the docs?

H

On Mon, Aug 31, 2015 at 3:44 PM, Kiri Choi [email protected]
wrote:

What is the current status of this method?

—
Reply to this email directly or view it on GitHub

#10 (comment).

---

Reply to this email directly or view it on GitHub:
#10 (comment)

Sent from my TARDIS with K-9 Mail. Wibbly-wobbly wordy gurdy.

from roadrunner.

I don't know either but its confusing to users. I've seen many people write
ExecutableModel.foo and get an error message. We need to think of someway
to deal with this. Maybe at the start of every page point out that when
someone sees ExecutableModel.foo it does not mean type that at the console.

Alternatively completely separate the API reference from the user manual.
So that user don't stumble on the docs with ExecutableModel in them.

H

On Mon, Aug 31, 2015 at 6:10 PM, Kyle Medley [email protected]
wrote:

Well, ExecuutableModel is the class name, which you get an instance of by
calling rr.model. Not sure what we can do, python docs are always in the
format ClassName.MethodName

On August 31, 2015 5:46:07 PM PDT, Herbert Sauro [email protected]
wrote:

Its not a method, which is what is confusing in the docs. Its a class
but
when someone sees it in the docs they think that have to call
executemethod. etc.

Is there someway to remove this word from the docs?

H

On Mon, Aug 31, 2015 at 3:44 PM, Kiri Choi [email protected]
wrote:

What is the current status of this method?

—
Reply to this email directly or view it on GitHub

#10 (comment).

---

Reply to this email directly or view it on GitHub:
#10 (comment)

Sent from my TARDIS with K-9 Mail. Wibbly-wobbly wordy gurdy.

—
Reply to this email directly or view it on GitHub
#10 (comment).

from roadrunner.

I think the best way is to first put something like instead of ExecutableModel and note that it should be changed for roadrunner instance to work. Otherwise, I can see some users actually trying model.foo as well. What do you think?

from roadrunner.

Yes we can try that.

H

On Tue, Sep 1, 2015 at 5:56 PM, Kiri Choi [email protected] wrote:

I think the best way is to first put something like instead of
ExecutableModel and note that it should be changed for roadrunner instance
to work. Otherwise, I can see some users actually trying model.foo as well.
What do you think?

—
Reply to this email directly or view it on GitHub
#10 (comment).

from roadrunner.

something like * instead of ExecuteModel *

from roadrunner.

Fixed via e98f85f

from roadrunner.