Skip to content

Commit

Permalink
small edits
Browse files Browse the repository at this point in the history
  • Loading branch information
kbjarkefur committed Sep 30, 2024
1 parent 55a2e0f commit 20824e0
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/mdhlp/lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ The lint command can be broken into two functionalities:

If an _output_file_ is specified with __using__, then the linter will apply the __Correction__ functionality and will write a new file with corrections. If not, the command will only apply the __Detection__ functionality, returning a report of suggested corrections and potential issues of the do-file in Stata's Results window. Users should note that not all the bad practices identified in __Detection__ can be amended by __Correction__.


| _options_ | Description |
|-----------|-------------|
| __**v**erbose__ | Report bad practices and issues found on each line of the do-file. |
Expand Down Expand Up @@ -48,13 +47,13 @@ __Avoid abstract index names__
- In for-loop statements, index names should describe what the code is looping over. For example, avoid writing code like this:

```
foreach i of varlist cassava maize wheat { }
foreach i of varlist cassava maize wheat { }
```

- Instead, looping commands should name the index local descriptively:

```
foreach crop of varlist cassava maize wheat { }
foreach crop of varlist cassava maize wheat { }
```


Expand Down Expand Up @@ -155,7 +154,7 @@ lint "test/bad.do"

For the detection feature you can use all the options but _automatic_, _force_, and _replace_, which are part of the correction functionality.

__**Options:**__
__Options:__

1. Show bad coding practices line-by-line

Expand Down

0 comments on commit 20824e0

Please sign in to comment.