From 20824e0cc98703e98f34d3a65b34c1733751facd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kristoffer=20Bj=C3=A4rkefur?= Date: Mon, 30 Sep 2024 09:15:36 -0400 Subject: [PATCH] small edits --- src/mdhlp/lint.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/mdhlp/lint.md b/src/mdhlp/lint.md index 0adc98d..6efe073 100644 --- a/src/mdhlp/lint.md +++ b/src/mdhlp/lint.md @@ -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. | @@ -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 { } ``` @@ -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