Skip to content

Commit

Permalink
add cite to wiki page on linting
Browse files Browse the repository at this point in the history
  • Loading branch information
IndrajeetPatil committed Dec 2, 2024
1 parent ba61bb3 commit 170df47
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 16 deletions.
2 changes: 1 addition & 1 deletion paper/paper.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ withr::local_options(list(

# Statement of Need

In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems (https://en.wiktionary.org/wiki/linting) and a linter is a tool used for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code.
In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems [@enwiki:1260589258] and a linter is a tool used for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code.

# Features

Expand Down
12 changes: 10 additions & 2 deletions paper/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,20 @@ @book{mcconnell2004code
publisher={Pearson Education}
}

@misc{ enwiki:1218663830,
@misc{enwiki:1218663830,
author = "{Wikipedia contributors}",
title = "Static program analysis --- {Wikipedia}{,} The Free Encyclopedia",
year = "2024",
url = "https://en.wikipedia.org/w/index.php?title=Static_program_analysis&oldid=1218663830",
note = "[Online; accessed 7-May-2024]"
note = "[Online; accessed 2-December-2024]"
}

@misc{enwiki:1260589258,
author = "{Wikipedia contributors}",
title = "Lint (software) --- {Wikipedia}{,} The Free Encyclopedia",
year = "2024",
url = "https://en.wikipedia.org/w/index.php?title=Lint_(software)&oldid=1260589258",
note = "[Online; accessed 2-December-2024]"
}

@Manual{Tierney2024,
Expand Down
26 changes: 13 additions & 13 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,19 @@ link-citations: true

In computer programming, "linting" is the process of analyzing the
source code to identify possible programming and stylistic problems
(<https://en.wiktionary.org/wiki/linting>) and a linter is a tool used
for linting. A linter analyzes code to identify potential errors,
stylistic issues, or deviations from coding standards. It helps ensure
consistency, readability, and best practices by flagging common
mistakes, such as syntax errors, unused variables, or improper
formatting. Linters are essential for improving code quality, preventing
bugs, and maintaining a clean codebase, especially in collaborative
development environments [@enwiki:1218663830]. `{lintr}` is an
open-source package that provides linters for the R programming
language, which is an interpreted, dynamically-typed programming
language [@base2023], and is used by a wide range of researchers and
data scientists. `{lintr}` can thus act as a valuable tool for R users
to help improve the quality and reliability of their code.
[@enwiki:1260589258] and a linter is a tool used for linting. A linter
analyzes code to identify potential errors, stylistic issues, or
deviations from coding standards. It helps ensure consistency,
readability, and best practices by flagging common mistakes, such as
syntax errors, unused variables, or improper formatting. Linters are
essential for improving code quality, preventing bugs, and maintaining a
clean codebase, especially in collaborative development environments
[@enwiki:1218663830]. `{lintr}` is an open-source package that provides
linters for the R programming language, which is an interpreted,
dynamically-typed programming language [@base2023], and is used by a
wide range of researchers and data scientists. `{lintr}` can thus act as
a valuable tool for R users to help improve the quality and reliability
of their code.

# Features

Expand Down

0 comments on commit 170df47

Please sign in to comment.