Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Minor modifications to the tutorial, mainly english aesthetics #284
schettino72 left a comment
Thank you so much for this. Very nice to get throughout review.
Feel free to add your name to AUTHORS file. I think you deserve some credit :)
Hey man! Thanks a lot for the nice feedback, it's really encouraging. Just wanted you to know I'll work on the changes you proposed, just give me some time.
I think the tutorial is well intended, but is still missing some love. On occasions it sounds like a list of steps, too recipe-like. I would try to give it a more personal touch, like if you were talking to the reader (this is, of course, just a matter of personal taste).
I don't know if you considered it or not, but perhaps it would be nice to pour in some comparisons with
A bit more motivation at the beginning would be appropriate too. Not regarding why you'd like to make an imports' dependency graph, but why would you do it using
That's all I can think of at the moment. If you agree on some of these, I volunteer to start making those changes. Just let me know.
Agree, my writing style is very boring
I have considered this. The problem is that it adds noise to people who do not know
So in general I am bit sceptic that this would be an improvement to write much in comparison to make. I think 2 or 3 notes regarding its differences might be ok.
I try to not repeat much content, specially introduction, I am afraid to bore people who actually read the stuff... I mean I get annoyed when some docs keeps claiming the same thing but doesnt go into the HOW.
Actually when I wrote the tutorial I pretty much plan it based on the list of use-cases.
Thanks so much. In general I agree with the changes but see a few concerns above.
Note that the tutorial is kind of new compared to the main documentation, the use-case section was not written by me. Of course improvements in any area are welcome...