Update guide.md

[ndilekli]

Naci's SWC homework

---

Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.

Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at [email protected].

---

[ldko]

Hello @ndilekli , thank you for submitting an update for the guide. I see you have opened two conflicting pull requests modifying the language of guide.md. Is this pull request meant to supercede #836 ? If you could close one of the PR's, it will inform which one we should review. Also, could you and a short explanation to the PR to explain what your goals for updating guide.md are. This will also help with the review. Thanks again!

[ndilekli]

Goals: 1) Further clarify why Python is a preferred programming language, 2) The existing guide sounded like functions are the most important part of a programming language, I changed the language a little and also provided an explanation why functions are very important (reusability and organization); and 3) Added comments about a common user error when dealing with multiple cells in Jupyter.

[ndilekli]

Hello yes, I am quite a novice with teamwork with git. I removed #836, and added an explanation of the goals in the comments section. Please let me know if that will not work and where else I can put that information. Thanks!

On Mon, Jun 22, 2020 at 6:14 PM Lauren Ko [email protected] wrote:

Hello @ndilekli https://github.com/ndilekli , thank you for submitting an update for the guide. I see you have opened two conflicting pull requests modifying the language of guide.md. Is this pull request meant to supercede #836 https://github.com/swcarpentry/python-novice-inflammation/pull/836 ? If you could close one of the PR's, it will inform which one we should review. Also, could you and a short explanation to the PR to explain what your goals for updating guide.md are. This will also help with the review. Thanks again!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/swcarpentry/python-novice-inflammation/pull/837#issuecomment-647582035, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA66AAOGH73U2MGC6KDOOTDRX5YOFANCNFSM4OEQOHBQ .

[ndilekli]

A question: Am I the one that will need to mark "Resolve conversation" once things look well, or will that be you @ldko ?

[ldko]

Good question @ndilekli :). In most cases it tends to be the maintainers that mark the conversations resolved. I tend to prefer to do that after commits are pushed to the branch/PR that address the conversation when that is relevant. I think the way things are now is fine, but let's see if anyone else from the community has any suggestions (let's give people a day or so), and then if you would go ahead and commit the decided upon changes, that would be great. Thank you very much for participating in the process!

[maxim-belkin]

let's give people a day or so

No need to wait, I'm here :)

Hi, Naci! Welcome to the Carpentries! I'm a co-maintainer on this lesson. Thank you for bringing this up and working on this.

I like your changes and all suggestions (Lauren's and Samuel's). And it looks like you mostly agree with them. So, because you're new to working with Git, I'd like to clarify that we (maintainers) review proposed changes and propose modifications and contributors (in this case this is you) are expected to update their pull requests if they agree with the proposed modifications. So, if you agree with the proposed changes -- please go ahead and make these modifications. You can do all that from your browser window -- navigate to https://github.com/ndilekli/python-novice-inflammation/blob/patch-2/_extras/guide.md, click the Pencil (Edit this file) icon, make the changes, then at the very bottom of that page describe your changes ("Update based on maintainers' feedback") and commit directly to patch-2 branch.

As it currently stands, I approve of the changes proposed in this PR provided that requested modifications are implemented.

Again, thank you for contributing to the lesson! This is looking great so far! 👍

[ndilekli]

navigate to https://github.com/ndilekli/python-novice-inflammation/blob/patch-2/_extras/guide.md, click the Pencil (Edit this file) icon, make the changes, then at the very bottom of that page describe your changes ("Update based on maintainers' feedback") and commit directly to patch-2 branch.

Hmm... I tried that but the 'Commit Changes" button is disabled.

I also notice that some of the improvements are not yet incorporated to this branch such as:

• Show that modifying code in an earlier cell requires re-running any subsequent cells in order for them to reflect the change.

[maxim-belkin]

Hmm... I tried that but the 'Commit Changes" button is disabled.

You need to type a title (such as "Update based on received feedback" or something more descriptive -- your choice) -- it should become enabled as soon as you do that.

I also notice that some of the improvements are not yet incorporated to this branch such as:

• Show that modifying code in an earlier cell requires re-running any subsequent cells in order for them to reflect the change.

That was Lauren's suggestion. You need to add it to your branch as I described above. Unless what you're saying is that you did and it doesn't show up. If you did it on your computer, make sure:

• you added and committed your changes to patch-2 branch
• pushed that branch to github with git push https://github.com/ndilekli/python-novice-inflammation.git patch-2

[ndilekli]

You need to type a title (such as "Update based on received feedback" or something more descriptive -- your choice) -- it should become enabled as soon as you do that.

I am still having the same problem. I tried with Chrome and Opera. with Chrome and Opera.

[maxim-belkin]

Looks like you were able to make one update -- https://github.com/swcarpentry/python-novice-inflammation/pull/837/commits/26b9528fdeba7984f581a87bfb713c9e8d690cf4

Do you remember what you did when you made that change?

[ndilekli]

Looks like you were able to make one update -- 26b9528

Do you remember what you did when you made that change?

I think all I did was to resolve, thinking that would make the suggested changes (by Lauren and Samuel) get incorporated into the version.

[ldko]

@ndilekli , when I go to your branch at https://github.com/ndilekli/python-novice-inflammation/blob/patch-2/_extras/guide.md and click on the pencil icon, at first I see at the bottom that the Commit changes button is disabled. However, I noticed when I click in the file editor (above the "Commit changes" form) and start modifying the text of guide.md, the Commit changes button becomes enabled (even if I haven't entered a title yet). Can you confirm if you have made edits to the guide.md text before trying to commit the changes?

[ndilekli]

@ldko: Very good, the commit (768817a) worked! I needed to make some manual changes in the file so that it would count as a commit, which makes sense in retrospect. I also noticed that there were some broken lines (due to my commenting most probably), which I tried to fix in this manual version as well.

So I guess whenever a conversation is resolved with some suggestions, that in itself becomes a commit, is that correct?

Let me know if you would like me to do anything else.

Thanks, Naci