Fixed typos in docstring of subroutines.py

[Fil158]

I fixed some grammar and general typos

[bobleesj]

@Fil158 for training purposes, could you please add a news file as instructed? Please refer to other PRs

[bobleesj]

@Fil158 As discussed via slack, let's also make this PR title a bit more descriptive

[Fil158]

I added the doc.rst on my local doc branch
in the news rep, with the comment under Fixed
Now, reading the instructions you provided me, that are clear till this point, it is unclear how to proceed...

[bobleesj]

I added the doc.rst on my local doc branch in the news rep, with the comment under Fixed Now, reading the instructions you provided me, that are clear till this point, it is unclear how to proceed...

Could you please share which part of the instructions is not clear to you? You can also refer to other PRs on how they create news file.

[Fil158]

[bobleesj]

That's not a formal part of the numbered step-by-step instructions. It's under Now, whenever you work in the repo Please explain which is not clear because I can also read that you've pasted.

[bobleesj]

Simply - you can push your news files by using git commit -m "\<summary of what the changes were\>" and git push

[bobleesj]

@Fil158

For testing your package via Pytest, please refer to How to test your package with specified Python version on GitLab. For your training, please also share the output of the Terminal test result here.

[Fil158]

Ok that is what I was asking, just add, commit and then push the doc.rst
Right?

[bobleesj]

Ok that is what I was asking, just add, commit and then push the doc.rst Right?

Alright, next time, you could save time by providing the course of action that you are about to take and I can confirm by giving you saying "yes" or thumbs-up.

[Fil158]

Now I'm starting to test: I'm in ..\diffpy.snmf
Is it the right command to paste?
conda create -n diffpy_snmf_env python=3.13

[bobleesj]

@Fil158 Instead of Removed undesirable comment, Remove extra <news items> under Fixed in news file is better for me (reviewer) so confirm that you've modified per the feedback.

[bobleesj]

In this case, the instruction appears to be clear: First, cd into the package directory, then follow these instructions: Please try first?

[sbillinge]

please see my comment. Thanks for the hard work Filippo and Bob!

[sbillinge]

please see comment in the other PR. We don't need a news item for just correcting typos.

[bobleesj]

@Fil158 Did the local pytest run for you? Please also address the in-line comment regarding news.

[bobleesj]

@Fil158 For us to be efficient, it would be appreciated if you could reply on GitHub comments within a reasonable time period of say within 24 hrs during normal working hours.

[bobleesj]

@Fil158 appears you've closed this issue without replies. Will another PR be created by you? Before closing any issues/PRs, since they are all used for bookkeeping and documenting purposes, please address the context.

[sbillinge]

reopening. We don't want to lose the conversation without resolving it.

[bobleesj]

@Fil158 Do you not receive notifications (emails)? I am just afraid whether things aren't configured properly since Billinge and I created multiples questions and follow-ups that would require your reply.

[Fil158]

Oh sorry, I wrote you on slack @bobleesj that local pytest run correctly

[Fil158]

No new PR on this topic

[bobleesj]

No new PR on this topic

because?

[Fil158]

@bobleesj please see the new PR #135

[bobleesj]

@Fil158 you can close this PR then - but it might be useful to a single sentence here why we've decided to make a new PR and reference the other PR link i.g. "Closing this PR - a new PR with a clean commit history is created here: #135"

[sbillinge]

@Fil158 you can close this PR then - but it might be useful to a single sentence here why we've decided to make a new PR and reference the other PR link i.g. "Closing this PR - a new PR with a clean commit history is created here: #135"

Thanks @bobleesj . @Fil158 Bob is right. When you write the comments don't treat this like a chat thread on a phone where it is only supposed to communicate a conversation between two people who know what is going on, but treat it as if you are leaving enough information that some new person in the future reading the thread can reconstruct what is going on.

[sbillinge]

Closing. Replaced by #135