Improving python client docs

[riibeirogabriel]

@navendu-pottekkat do you can think a way to improve the quality of the docs?

[riibeirogabriel]

I did have think a way, but is too much classes and methods in this package.

[pottekkat]

I will check it out. We can find some way. I will work on it through the week.

[riibeirogabriel]

thanks! I also will think a way.

[pottekkat]

@riibeirogabriel Could you possibly comment the example code? And is there any way to split the preprocessing_code other than writing it as preprocessing_code = ```from ...

We can also change the '_' in the imports to '-'

[riibeirogabriel]

The preprocessing_code is sended as string in API, and the model builder microservice interpret this string as python 3 code, this code is the right way to work, but maybe we can write a session with the preprocessing_code uncommented, to highlight the python sintax and make the comments, what do you think? and ok, we can change from "_" to "-".

[pottekkat]

The preprocessing_code is sended as string in API, and the model builder microservice interpret this string as python 3 code, this code is the right way to work, but maybe we can write a session with the preprocessing_code uncommented, to highlight the python sintax and make the comments, what you think? and ok, we can change from "_" to "-".

Oh I did not know it worked that way. Then you should do what you think the best. Then you can comment and change the underscores.

I will take a look at the docs repo and the landing page tomorrow. You can also work on getting a domain address if you are interested. It is late here and that is one of the problems when we are working from 2 opposite ends of the world!

[riibeirogabriel]

Okay, it will see this and make something, thanks!

[riibeirogabriel]

@navendu-pottekkat We can create another repo to serve the landing page in a github.io domain? It is a temp solution, till i provide a domain in next releases of learingOrchestra,and i don't have knowledge in front end to build a landing page.

[pottekkat]

@riibeirogabriel Yes, that is what I was planning to do. We will create a landing page in a new repo. And later we can add the domain. And we can keep the docs in a subdomain like docs.website.com

It would be best if you get the domain ASAP and we can start the promotion. Lot of folks will contribute for hacktoberfest

[riibeirogabriel]

@navendu-pottekkat alright, I will provide the domain in this week!

[riibeirogabriel]

I have installed the learning-orhcestra-client and success! but to run the python interpreter on .py file, is throwed a exception in "import learning-orchestra-client" as invalid sintax, the PEP8 recommends use underscores in variables, maybe it can be relationed.

[riibeirogabriel]

@navendu-pottekkat and thanks for all help for this project, you did make the learningOrchestra more professional and friendly to users!

[pottekkat]

Then maybe we should change that in the README

[pottekkat]

Actually in the readme it is learning_orchestra_client