-
-
Notifications
You must be signed in to change notification settings - Fork 77
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Amend configuration.md #608
base: main
Are you sure you want to change the base?
Conversation
I have tried to clarify a few matters and to polish some of the wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
@@ -1,7 +1,7 @@ | |||
# Configuration | |||
selene is meant to be easily configurable. You can specify configurations for the entire project as well as for individual lints. | |||
|
|||
Configuration files are placed in the directory you are running selene in and are named **selene.toml**. As the name suggests, the configurations use the [Tom's Obvious, Minimal Language (TOML)](https://github.com/toml-lang/toml) format. It is recommended you quickly brush up on the syntax, though it is very easy. | |||
Configuration files apply to the directory (and subdirectories) in which they are placed. So, to control how selene behaves when it lints scripts in, say, `~/myScripts` and below, place the configuration file within (the top-level of) `~/myScripts`. Each configuration file is to be called **selene.toml**. As the file suffix suggests, configuration files use the [Tom's Obvious, Minimal Language (TOML)](https://github.com/toml-lang/toml) format. It is recommended you quickly brush up on the syntax, though it is very easy. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Configuration files apply to the directory (and subdirectories) in which they are placed. So, to control how selene behaves when it lints scripts in, say,
~/myScripts
and below, place the configuration file within (the top-level of)~/myScripts
.
This isn't accurate because the config doesn't apply to the scripts in the folder. It applies to the command when ran from the folder, which can lint on a different folder.
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. |
Which part of that phrase is ambiguous? The proposed change changes are not accurate. See #608 (comment). |
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.
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. |
I have tried to clarify a few matters and to polish some of the wording.