Doc: Improve grammar in os.walk example

[wjandrea]

Comma should be a colon, as written at the same spot under fwalk.

---

📚 Documentation preview 📚: https://cpython-previews--138466.org.readthedocs.build/

Specifically: https://cpython-previews--138466.org.readthedocs.build/en/138466/library/os.html#os.walk

[StanFromIreland]

I don’t see any particular benefit, it seems like a cosmetic change to me.

[wjandrea]

I don’t see any particular benefit, it seems like a cosmetic change to me.

How not? There's a comma splice. Replacing the comma with a colon fixes the grammatical error.

[AA-Turner]

?

Suggested change

	walking the tree bottom-up is essential: :func:`rmdir` doesn't allow
	walking the tree bottom-up is essential, because :func:`rmdir` doesn't allow

[wjandrea]

Sure, that's also a good suggestion, but fwalk already uses a colon:

cpython/Doc/library/os.rst

Lines 3767 to 3768 in 424e2ab

	In the next example, walking the tree bottom-up is essential:
	:func:`rmdir` doesn't allow deleting a directory before the directory is

So I used the same for consistency. No need to edit two spots when one will do, but if you think it would be clearer to add "because", by all means.

Another option is:

walking the tree bottom-up is essential since :func:`rmdir` doesn't allow

[ZeroIntensity]

We could also use a semicolon, but I like this more.

[wjandrea]

@ZeroIntensity Yeah, a semicolon would fix the grammar, but using a colon does the same and implies "because".

[AA-Turner]

Excess brevity is not called for here, I think 'because' is fine. Given it's immediately before a role that also starts with :, having the colon could be a little confusing.

[ZeroIntensity]

No need to edit two spots when one will do, but if you think it would be clearer to add "because", by all means.

It's fine to have inconsistent styles -- English doesn't follow PEP 8 :)

[ZeroIntensity]

I've removed pending because this is indeed a grammar error.

[StanFromIreland]

Please do not use the Update Branch button unless necessary (e.g. fixing conflicts, jogging the CI, or very old PRs) as it uses valuable resources. For more information see the devguide.

[wjandrea]

@StanFromIreland Yeah, sorry, I'm so used to clicking it mindlessly for something else I'm working on then realized it was totally unnecessary here.