
Hi all. Stem is having its initial release later this month, and in anticipation of it I've been expanding its tutorials... https://stem.torproject.org/tutorial.html Are there any rough spots in these tutorials? Other categories that we should cover? Suggestions welcome! -Damian

Damian Johnson:
Hi all. Stem is having its initial release later this month, and in anticipation of it I've been expanding its tutorials...
https://stem.torproject.org/tutorial.html
Are there any rough spots in these tutorials? Other categories that we should cover?
Suggestions welcome! -Damian
No suggestions, just want to give you some props! It's definitely some of the better library documentation I've seen. Clean, concise, and quite aesthetically pleasing. ~abel

Damian Johnson:
Hi all. Stem is having its initial release later this month, and in anticipation of it I've been expanding its tutorials...
https://stem.torproject.org/tutorial.html
Are there any rough spots in these tutorials?
In Tortoise and the Hare: * I wonder if the use of the fancy functools.partial should not be replaced by a two lines 'def'. YMMV. * For people unfamiliar with the curses API, `curses.wrapper` might look like an exotic construct. Maybe it's worth a comment. On Double Double Toil and Trouble, arm really stands out in a weird way. It looks more like a subtitle than as part of the list. Also, as the name is labeled in a different color than the link just below, it's unclear that it's actually a link. Other than these minor comments, this is really an amazing piece of work. :) -- Jérémy Bobbio .''`. lunar@debian.org : :Ⓐ : # apt-get install anarchism `. `'` `-

Hi Lunar, thanks for the feedback!
* I wonder if the use of the fancy functools.partial should not be replaced by a two lines 'def'. YMMV.
Hmm, I'm not sure which is more confusing: scoping rules of an inline function or bundling references via a partial. Personally I find the partial to be a little more direct. Expanded the comment explaining it.
* For people unfamiliar with the curses API, `curses.wrapper` might look like an exotic construct. Maybe it's worth a comment.
Good point. Added.
On Double Double Toil and Trouble, arm really stands out in a weird way. It looks more like a subtitle than as part of the list. Also, as the name is labeled in a different color than the link just below, it's unclear that it's actually a link.
My intention with the page was to have two separate sections: projects and scripts. Unfortunately since there's only a single project using stem that's presently not very clear. Hopefully that'll improve soon. Throughout the site I'm using this image/label pattern for section links so I'm hoping that'll make the linking a little clearer after we add more. Might be something that I'll need to revisit.
Other than these minor comments, this is really an amazing piece of work. :)
Thanks!
participants (3)
-
Abel Luck
-
Damian Johnson
-
Jérémy Bobbio