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

Language fixes #750

Merged
merged 77 commits into from Dec 6, 2017
Merged

Conversation

mark-summerfield
Copy link
Contributor

This is a first raft of changes. I'll try to do more next week.

I find this unclear (and it should be according not accordingly):

- **Rigid Body**: The object will behave accordingly to its shape.

Do you mean:

- **Rigid Body**: The object will behave according to its shape's
  properties.

It seems confusing to me that Blender has Sensors and Actuators and so
does morse but the morse ones are different. Pity the morse ones aren't
called, say BotSensor(s) and BotActuator(s), but I guess it is too late
now:-)

I'm surprised you haven't added an option to Blender to select a whole
robot since it is tricky, but perhaps that isn't possible.
I removed spurious '\'s from one of the code snippets. Using '\'s is
poor style and unnecessary.

I also changed the last example's def name(): to def name(self).
Or did you mean @staticmethod def name(): ?
I find this unclear.

   all the objects ending with the empty, and press :kbd:`Shift+M`).
Don't like the name semanticC for the camera. Would prefer camera if
there's just one or catEyeCamera if there's more than one.

I don't understand the word "Sick"; should it be "Stick"?
Personally, I'd call the cameras leftCamera and rightCamera (or
cameraLeft and cameraRight).

Maybe "Sick" should be written "SICK"?
The code examples use tabs rather than 4 spaces contradicting PEP8.
In some files you write Menu >> Option and in others Menu > Option.
Personally I'd write Menu→Option.

Also, in some files you write :kbd:`Ctrl+a` and in others
:kbd:`Ctrl + a`; personally, I'd always use the former.

Also, the Tab and Enter keys are always capitalized.

In this file you write with Morse() as sumu: elsewhere you write
with Morse() as sim: which I prefer.

Shouldn't really encourage people to use % formatting. I'd change
pose_received to:

  def pose_received(pose):
      print("The Ranger is currently at {}".format(pose))

In most of the API you use dicts or **kwargs for parameters so at least
people know what they are setting. But for Actuator.add_data() it is
just *args which seems a pity. Also the type being specified by a str
(e.g., 'float') rather than by a type object seems strange.
I don't know what is meant by "for every lecture of the sensor".
You mention the use of avconv but don't show an apt-get line for
obtaining it (or for obtaining the necessary codecs).
For rqt_plot the x and y arguments are , separated but the z is space
separated which seems odd to me?

I changed 'paste the following code' to 'type the following code'
because if you paste a lump of code like this into the REPL it won't
work unless you do it line-by-line (plus one block for the function).
Around line 190+ I added some information which appeared to be missing,
so worth checking if I got it right:-)
Is this true?
- The first line tells MORSE that this is a builder script.
Does MORSE actually read the text of the .py file?

Or should it be something like:

- The first line imports the entire **Builder API** for use in the script.

(Of course, import * is usually poor practice.)
@mherrb
Copy link
Contributor

mherrb commented Oct 18, 2017

Reviewed-by: Matthieu Herrb

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

Successfully merging this pull request may close these issues.

None yet

4 participants