search

chrisdembia / python-yeadon-paper

A paper about https//github.com/chrisdembia/yeadon
2 stars 1 forks source link

UML attributes have no explanation #32

Closed moorepants closed 9 years ago

moorepants commented 9 years ago

The first reviewer suggested that we explain the attributes in the UML diagram.

I responded on the F1000 Research with some explanation. Maybe we need to include that info in some way...but it could get verbose because there are a lot of attributes.

@chrisdembia @monthubbard

chrisdembia commented 9 years ago

Thanks for doing that. I'm going to wait until we get all reviews before processing them. We can explain the more ambiguous ones in the caption and refer people to the proper documentation.

moorepants commented 9 years ago

I think it is fine to edit per review. F1000 keeps track of all the paper versions. Then you potentially avoid the reviewers commenting on the same issues. But either way is fine.

moorepants commented 9 years ago

@chrisdembia What should we do about this one?

chrisdembia commented 9 years ago

I'll add to the caption.

moorepants commented 9 years ago

I should have copied in the comment from the reviewer:

My only minor suggestion is for the authors to add definitions for terms in Figure 4 that are not self-descriptive. For example, it is not clear what rel_center_of_mass and rel_inertia are defined relative to.

This seems to be more about what "relative" means.

moorepants commented 9 years ago

I just noticed that this docstring isn't very explicit about what "relative" means:

http://yeadon.readthedocs.org/en/latest/segment.html#yeadon.segment.Segment.calc_rel_properties

But that these are explicit:

http://yeadon.readthedocs.org/en/latest/segment.html#yeadon.segment.Segment.rel_center_of_mass http://yeadon.readthedocs.org/en/latest/segment.html#yeadon.segment.Segment.rel_inertia