Kampfkarren
Amend configuration.md
I have tried to clarify a few matters and to polish some of the wording.
Thank you, but the changes for the most part don't seem to make the docs more readable. They just say the same thing using more words.
No they don't. For: they disambiguate the phrase 'the directory you are running selene in'; they add an example; they improve the English.
EDITED to remove an extraneous space.
Thank you, but the changes for the most part don't seem to make the docs more readable. They just say the same thing using more words.
No they don't. For: they disambiguate the phrase ' the directory you are running selene in'; they add an example; they improve the English.
Which part of that phrase is ambiguous? The proposed change changes are not accurate. See https://github.com/Kampfkarren/selene/pull/608#discussion_r1660038027.
Thank you for your time.
'The proposed [. .] changes are not accurate': that is what happens when mere users - or at least new users like me - end up being the ones who try to make these sorts of changes.
'Which part of that phrase is ambiguous?' All of it. For, 'the directory you are running selene in' is ambiguous between the following three meanings.
-
The directory from which selene is run, in the sense of the directory containing the selene binary.
-
The directory that, in a terminal, the user occupies when she invokes selene.
-
The directory towards which one is directing the operation of selene, i.e., the target directory for selene's linting.
I had come to think that 3 was meant. But - and this is evidence of the ambiguity - your comment shows that 2 is meant. I could revise my PR.