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

First challenge #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

Akashf
Copy link
Collaborator

@Akashf Akashf commented Oct 13, 2020

No description provided.

Copy link
Member

@colton-smith colton-smith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Submission / Git Practice:

  • The title of the pull request does not follow the formula provided in the challenge instructions
  • The branch name is well done
  • There is no description for the pull request, you typically always want to briefly summarize what changes are in the pull request
  • The commit message does not indicate what changes were made in the commit, commit messages should be concise, descriptive comments about what you changed/added in the commit.

Code:
Overall well done, the comments are primarily style and other nit picky things like spelling. These are usually a pretty common thing to have noticed in pull requests. This challenge was much more focused on the workflow then the actual code,

Few things tp note:

  • navigate() can only be called once and then will block in an infinite loop of reading the gps sensor
  • pass is left in the code unnecessarily
  • Unused variable moveX
  • The navigate method will only update one Axis at a time as it returns after effecting the desired change, it may have been more efficient to make changes for each axis in a single call to navigate

Comment on lines 75 to +76


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AS per PEP8 - all methods are surrounded only by a single line of whitespace

def update_current_position(self):
""" Updates the current position of the TBM """
self.current_position = self.GPS.getPos()
pass
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line serves no purpose right now, all uses of pass should be removed when the method is implemented.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It just serves as a placeholder


success = true

# Assume all move commands with distance esentially finish instintaniously and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*essentially, *instantaneously

@@ -32,27 +32,27 @@ class will interface with our onboard GPS sensor to get thecurrent position, and
|
|
below target

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reason there is a lot of lines removed and then added - just wondering if your ide is telling you to indent with tabs or something

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Akashf I'm assuming you ran a linter or something over the code and it picked up some trailing whitespace. For future reference, if you make any linting changes, try to put them in their own commit. Makes it easier for the reviewer to actually see your code changes.

if moveY > 0:
success = self.steering.move_right(moveY)
if !success:
print("Move right did not execute properly") # print used as a substitute for any place that we'd want to print to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment explaining print as a placeholder for a log is good but could have been placed above the call to print to adhere to the 80 char line length limit

Comment on lines +132 to +133
while self.current_position != self.desired_position:
self.update_current_position()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will be an infinite while loop that just reads the GPS, this would block the application when navigate is called.

Comment on lines +125 to +126
# Assume it only has to move forward in the X direction.
if self.current_position != self.desired_position:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand that this code is only reached when Z and Y have both been adjusted, but it would make it easier to read if you specified that you are checking x here. Also, moveX is an unused variable


# Assume it only has to move forward in the X direction.
if self.current_position != self.desired_position:
success = self.steering.move_forward()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move_forward probably should have an argument for how far to move.

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.

3 participants