Skip to content

docs: Added information on how to run the linter. #7534

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

docs: Added information on how to run the linter. #7534

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a7923aa
docs: Added information on how to run the linter.
diosney Jul 4, 2016
390101b
docs: Added clarification about the linter.
diosney Jul 4, 2016
d85a388
docs: Added clarification about the linter execution.
diosney Jul 5, 2016
50e5745
docs: Linter line rewording.
diosney Jul 5, 2016
2f42d83
docs: Changed for consistent verb tense.
diosney Jul 5, 2016
6a61891
repl: Fixed post-final nit in`completer` function doc.
diosney Jul 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ To run the tests:
$ make test
```

To run the linter:

```text
$ make lint
```

To run the native module tests:

```text
Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@ $ ./configure && make -j8 test
Make sure the linter is happy and that all tests pass. Please, do not submit
patches that fail either check.

You can check if the linter is happy by running:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I’d note that the linter is usually run as part of make test.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax Agree, but if the tests are throwing errors that will disable you to properly lint the code.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@diosney Yep, I’ve seen the thread that prompted this PR, and I’m in favour of having the information of how to run only the linter noted here – I’d just want to save folks the trouble of thinking they have to run the linter separately under normal circumstances.

I don’t feel too strongly about it, and if you want to keep it this way, I won’t be in the way of that. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax Oy! I think I understand you now! I just though you didn't see this addition as useful. Sorry for that.

I will add your proposal right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax Just added your proposal, can you check it? Thanks!


```text
$ make lint
```

If you are updating tests and just want to run a single test to check it, you
can use this syntax to run it exactly as the test harness would:

Expand Down