Skip to content
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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

LinuxOnTheDesktop
Copy link
Contributor

I have tried to clarify a few matters and to polish some of the wording.

I have tried to clarify a few matters and to polish some of the wording.
Copy link
Collaborator

@chriscerie chriscerie left a 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.
Copy link
Collaborator

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.

@chriscerie chriscerie marked this pull request as draft June 29, 2024 23:28
@LinuxOnTheDesktop
Copy link
Contributor Author

LinuxOnTheDesktop commented Jun 30, 2024

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.

@chriscerie
Copy link
Collaborator

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 #608 (comment).

@LinuxOnTheDesktop
Copy link
Contributor Author

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.

  1. The directory from which selene is run, in the sense of the directory containing the selene binary.

  2. The directory that, in a terminal, the user occupies when she invokes selene.

  3. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants