search

rohitvarkey / ThreeJS.jl

Julia interface to WebGL using Three-js custom elements and Patchwork.jl
https://rohitvarkey.github.io/ThreeJS.jl
Other
56 stars 15 forks source link

Document << punctuation #29

Open drjrkuhn opened 8 years ago

drjrkuhn commented 8 years ago

I keep seeing the << (left-shift operator) throughout your code -- without knowing what it actually does. It is not part of the standard Julia punctuation set. And, unfortunately, search engines have a difficult time with punctuation.

After searching around the Julia docs, the REPL help system, and looking through your dependency chain, I finally found the redefinition of << in Patchwork.jl as an Element concatenation/push operation. Since your examples rely heavily on the << operator, I suggest that you add a section on it in your README.md file explaining its use.

The << operator redefinition is actually explained in the Patchwork.jl library README, but it doesn't hurt to readdress the unfamiliar operator syntax in ThreeJS.

rohitvarkey commented 8 years ago

@drjrkuhn You're right! I will be happy to accept a PR adding this to the README.