swcarpentry / collaborative-lesson-development

10 Simple Rules paper on collaborative lesson development
https://arxiv.org/abs/1707.02662
Other
22 stars 6 forks source link

Figures aren't used #45

Closed gvwilson closed 7 years ago

gvwilson commented 7 years ago

Aside from their parenthetical mention at the end of the Introduction, neither of the figures is referred to in the main set of rules. I am not sure if both of these are necessary. Figure two, especially, encompasses a number of rather complex ideas about community building and lesson development that are not directly discussed at any length within the text. The second figure seems the more useful of the two, but in any event, I think both warrant more attention in the text or in captions if they are to be kept.

raynamharris commented 7 years ago

My intent for figure 1 was to provide a graphical abstract or a concise summary captures the content of the article in a single glance. I think it serves its purpose well.

I don't think that referencing fig 1 more within the body would improve the paper.
I do agree that an elaboration of the caption would improve the paper.

So, unless anyone objects, I'll add a caption to fig1.

ianmilligan1 commented 7 years ago

That was my understanding of Figure 1 as well, @raynamharris, so adding a captain sounds good. I think a parenthetical introduction at the end of the introductory section is sufficient.

k8hertweck commented 7 years ago

Figure 2 should be referenced at other points in the manuscript. Now that I've updated the figure (see #49 ) I can take a look at other places to reference it.

It just occurred to me that I don't know where to include the caption. Should this be included with the figure itself, or as a legend someplace in the manuscript?

raynamharris commented 7 years ago

@k8hertweck "Figure captions are inserted immediately after the first paragraph in which the figure is cited. Figure files are uploaded separately."

raynamharris commented 7 years ago

Closing this issue now