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

Readme would need to be updated #4

Open
HtheChemist opened this issue Jun 22, 2020 · 14 comments
Open

Readme would need to be updated #4

HtheChemist opened this issue Jun 22, 2020 · 14 comments

Comments

@HtheChemist
Copy link

Most function cited in the readme have been changed in the last few commits. Would it be possible to update them? Using the library is quite confusing at the moment.

@Pipe-Runner
Copy link
Collaborator

I'll try to find some time and do the needful. Meanwhile I would appreciate the help in updating the readme.

@HtheChemist
Copy link
Author

I am currently trying to implement it using the PSLab implementation as a reference. I will try to update everything once I have managed to make it work.

@Pipe-Runner
Copy link
Collaborator

@HtheChemist @orangecms @2secslater I have updated the README.md as requested by @HtheChemist . Please cross-check the index.js and README and let me know if I have missed anything. Thanks, folks for all the support.

@orangecms
Copy link
Contributor

I have a few thoughts:

  • let's make the extra options optional; I made it necessary to pass an empty object at least, which is not desirable, sorry :/
  • prefer concept over naming; variable names, file and directory names should not be as specific so that they rather reflect the general idea in the examples
  • explain the relationship with the component lifecycle and how it applies to hooks which many people use nowadays

The latter two would work without referencing specifics of PSLab allowing for people to still think in terms of their exisiting project structure. What do you think @AakashMallik?

@HtheChemist could you elaborate a bit on what exactly confuses you, and maybe point out how you would like to use the library, maybe refer to a project if it's open? Thanks! :)

@Pipe-Runner
Copy link
Collaborator

@orangecms It would be nice if you could drop a PR for point 1. Else I would try to get this done this weekend.
For 2nd point, you are right, I am planning on releasing a demo app for people to use load-balancer. Need some time for this. Help would obviously be appreciated. I will finish up my last article on this regarding this example too.

3rd point needs some discussion. If you are okay with it, let's have a vid chat regarding this.

This lib may not be that big of a deal but given people are actually using it for serious projects gives me hope.

@HtheChemist
Copy link
Author

@orangecms I was able to infer from looking at the code from another project but basically it was simply that the function name were changed. The largest confusion was in the .onInitialize() become .job().

Once I understood this it was much clearer. Thanks for updating the document.

@Pipe-Runner
Copy link
Collaborator

@HtheChemist Glad to know that you found the changes cleaner. That was indeed the intention. Thanks for being patient with the lib. :-)

@Pipe-Runner
Copy link
Collaborator

@orangecms I am almost finished with writing an article for this library and will spin up a sample app by the weekend. I'll ping it over to u as soon as it is done.

@orangecms
Copy link
Contributor

Oh cool, I'll be glad to share it, thank you! :)

Are you also in the PSLab Gitter chat btw? We have weekly meetings now, would be great to see you there sometimes if it's possible for you. ;)

@Pipe-Runner
Copy link
Collaborator

@orangecms Not on gitter, but I'd love to join the weekly meeting. I am finding it really hard to squeeze out spare time juggling between office-dev-ML research-and higher education prep work. But I'll try.

@Pipe-Runner
Copy link
Collaborator

@orangecms https://medium.com/heuristics/electron-react-python-part-3-boilerplate-3-3-1a9cdd0a6b9d
The article is finished!! Let me know what you think.

@Pipe-Runner
Copy link
Collaborator

@orangecms Also sorry about the mess at PSLab, Mario and I are not on good terms... I wrote that project from scratch, I am the rightful maintainer to the project and Mario for some odd reason revokes my rights. This is simply an insult that I am not going to deal with. I hope we get to work together on something that does not involve FOSSASIA.

@orangecms
Copy link
Contributor

@orangecms https://medium.com/heuristics/electron-react-python-part-3-boilerplate-3-3-1a9cdd0a6b9d
The article is finished!! Let me know what you think.

Sorry for the late response - I had already taken a look, now came back to it.
I think it's a good intro and you're explaining how IPC is happening through stdin/stdout. Maybe elaborate a bit more at this point, what a child process is and why serialization is needed? That could give a reader without much POSIX knowledge the understanding of the basic concept. Otherwise it's a great starting point. :)

@Pipe-Runner
Copy link
Collaborator

@orangecms Aah, good point. I'll try cover it in the wiki or the article. Thanks for your input. Cheers.

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