style: requirements names, consistency wrt to singular/plural

[sbillinge]

Problem

I can never remember if it is test.txt or tests.txt or doc.txt or docs.txt

it would sure be nice if we had a kind of group standard that these things (and also directory trees) are always singular or plural but not some arbitrary choice.

Proposed solution

Pick one or the other (singular or plural) and go with it.

IT would be a huge pain to change directory names at this point (breaks everything), so we can use that as a guide. We have src, news (which don't depend on pluraity). tests and doc. Ouch, already mixed. But it points in the direction of going with plural?

If we go with plural we would like requirements/tests.txt

Thoughts?

[bobleesj]

@sbillinge

Agreed. It occurs to me quite often for the requirements files as you've mentioned. So I agree we use plural.

And the community standard for the doc folder is docs (per readthedoc) shown below as well:

I can make a quick PR

[bobleesj]

Ref: https://about.readthedocs.com/

[bobleesj]

@Sparks29032 @zmx27 @ycexiao @cadenmyers13 @Tieqiong

Please note that this is an API breaking change. For now, we can simply update requirements/test.txt to requirements/tests.txt because our CI will use tests.txt.

Ref: scikit-package/release-scripts#172

[bobleesj]

@sbillinge

the two manuscripts are updated.

[sbillinge]

We will need this change in all our packages. Do you have a nice script that makes an issue in the whole stack? Let's also update COC at the same time, and doc->docs. ANything else is pesky technical debt.

tl;dr: one issue on every package in the stack to change all thre ethings at the same time (and anything else I forgot)

[bobleesj]

We will need this change in all our packages.

Yes. we should. Maybe @cadenmyers13 can do this on creating issues?

I've shared the bash script with @cadenmyers13 and it's pretty easy to use as long as the local repos are connected to upstream, which I assume Caden already has a bunch.

[bobleesj]

@bobleesj will take care of all other skpkg related repos as tracked in #552 (comment)

[sbillinge]

@cadenmyers13 can you do this?

[cadenmyers13]

@sbillinge yes I can. @bobleesj can you send me the script again?

[bobleesj]

Yup sent via email.