imagej / imagej-scripting

ImageJ-specific applications of the SciJava script languages
Other
25 stars 15 forks source link

Clarify sample images #7

Closed etadobson closed 8 years ago

etadobson commented 8 years ago

Comments have been added to indicate to users the images to use within individual tutorials.

etadobson commented 8 years ago

@ctrueden @bnorthan take a look. in the comments - i just indicated the images to use within each tutorial... hopefully it's more clear now for the users.

hinerm commented 8 years ago

@bnorthan I asked @ctrueden about this and he mentioned that he was going to let you look at this one. would you mind taking a quick look that you agree with these comments? Thanks! :octopus:

etadobson commented 8 years ago

Thanks @bnorthan -- I'll make those changes ...

etadobson commented 8 years ago

@bnorthan -- changes have been made. take a look...

bnorthan commented 8 years ago

Looks great. @etarena is there anything else you want to add?? If not I can merge it.

etadobson commented 8 years ago

@bnorthan nope - we're all good.

etadobson commented 8 years ago

@bnorthan done.

bnorthan commented 8 years ago

Awesome!

hinerm commented 8 years ago

@bnorthan @etarena so I was the one who said each commit message should have some identifier differentiating where the change was located. This is actually valuable information as it allows someone to glance at the commit messages and know (or at least have a suggestion) the location of the changes int hat commit. If the messages were undesirable or confusing, I would have made them more specific instead of less.

This article is a great one on Git commit messages, since it links back to practical examples - like Linux and Git - which illustrate meticulous documentation in their commits messages and titles.

There are always other ways of discovering this information, but a commit message is typically your "first line of defense" for conveying information to other developers... so if we use duplicate messages we are missing an opportunity for communication.

etadobson commented 8 years ago

@hinerm oops.

ctrueden commented 8 years ago

I agree with @hinerm!

Although in this case, these changes were so small they probably could have just been a single commit with message "Document recommended images" to avoid the whole issue. :wink:

hinerm commented 8 years ago

@etarena it's fine. I did not give a good explanation of why I was telling you to put those prefixes there in the first place.

"Document recommended images" to avoid the whole issue.

This is true... but more commits = more complex rebase = more fun!

etadobson commented 8 years ago

@hinerm ... now that you said that - I remember having that 'specific' conversation on 'specificity'... lesson double-learned. ;) (at least i got the hang of intro-to-rebasing!)

bnorthan commented 8 years ago

@hinerm, @ctrueden, @etarena

OK that makes sense. Sounds like duplicate commit messages should be avoided after all.