morse-simulator / morse

The Modular OpenRobots Simulation Engine
http://morse-simulator.github.io/
Other
353 stars 156 forks source link

Corrected/improved the English + comments #726

Closed mark-summerfield closed 7 years ago

mark-summerfield commented 7 years ago

Using * imports is bad style. You should show how to use morse without using them.

If the Environment object must be called env, you ought to say so.

In bash, if you type "morse run my" and then tab-complete you'll get "morse run mysim/" which will produce an error. Surely, it could be smart enough to look for "mysim/" and if it doesn't find it fall back to trying "mysim"?

Most of the English seems British, but then you use the American meter rather than British (French!) metre.

On line 231 I don't understand where the atrv object comes from; why isn't it robot.rotate(...)?

Clearly the auto-naming is useful for beginners, but surely you should advise people to explicitly name?

Sometimes morse is written MORSE and other times Morse -- you ought to choose one and keep to it throughout:-)

From line 547 the syntax highlighting for code blocks is wrong: may just be a bug in the github editor though.

PierrickKoch commented 7 years ago

once again, thanks for all the review!

severin-lemaignan commented 7 years ago

Closed by c0b5854 Changes merged; other comments tracked in #744