-
Notifications
You must be signed in to change notification settings - Fork 1
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
Refresh #12
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! I have just a couple suggestions on the help_text
s.
calories = models.FloatField(help_text='Calories for the day') | ||
activity_calories = models.FloatField( | ||
help_text='Activity calories for the day') | ||
distance = models.FloatField(help_text='Distance travelled during the day') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brad It might be helpful to put the units here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@grokcode Good call, the documentation doesn't specify but it's probably miles. That would fit well with the examples and it looks like distance on other API end points come in miles.
user = models.ForeignKey(UserModel, help_text="The device's user") | ||
device_type = models.CharField( | ||
max_length=64, | ||
help_text='The device type. At this time, will always be "shine"') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@grokcode Oh, I forgot, thanks!
LGTM! Thanks for this update! |
@orcasgit/orcas-developers Please review. I updated the tox matrix and added docstrings to all the models and
help_text
s to all the model fields.