From bccdad1031eb6826211c3c83659a2c6a3beeb986 Mon Sep 17 00:00:00 2001 From: Quarto GHA Workflow Runner Date: Fri, 17 Jan 2025 16:10:35 +0000 Subject: [PATCH] Built site for gh-pages --- .nojekyll | 2 +- configuration.html | 22 +++++++++++----------- search.json | 4 ++-- sitemap.xml | 10 +++++----- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/.nojekyll b/.nojekyll index 5e8fd395..be2ae742 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -41066870 \ No newline at end of file +2466d3be \ No newline at end of file diff --git a/configuration.html b/configuration.html index d5070b4d..564f056f 100644 --- a/configuration.html +++ b/configuration.html @@ -197,7 +197,7 @@

On this page

  • indent-width
  • indent-style
  • line-ending
    • -
  • ignore-magic-line-break
    • +
  • persistent-line-breaks
    • @@ -233,7 +233,7 @@

    Example configuratio indent-width = 2 indent-style = "space" line-ending = "auto" -ignore-magic-line-break = false +persistent-line-breaks = true

    Configuration recommendations

    @@ -309,17 +309,17 @@

    line-ending

  • "native": Line endings will be converted to \n on Unix and \r\n on Windows.

    • -
    -

    ignore-magic-line-break

    -

    Whether or not magic line breaks should be ignored.

    -

    Either true to ignore magic line breaks, or false to respect them, with a default of false.

    -

    Air respects a small set of magic line breaks as an indication that certain function calls or function signatures should be left expanded. For example, the following list could be flattened to one line and would still fit within a line-width of 80, however, it remains expanded due to the magic line break between the opening ( and the first argument, apple.

    +
    +

    persistent-line-breaks

    +

    Whether or not persistent line breaks are allowed.

    +

    Either true to respect persistent line breaks, or false to ignore them, with a default of true.

    +

    Air respects a small set of persistent line breaks as an indication that certain function calls or function signatures should be left expanded. For example, the following list could be flattened to one line and would still fit within a line-width of 80, however, it remains expanded due to the persistent line break between the opening ( and the first argument, apple.

    dictionary <- list(
   apple = 0.75,
   banana = 0.25,
   cherry = 0.50
 )
    -

    Similarly, this function signature could also be flattened, but is not, due to the magic line break between the opening ( and the first parameter, ....

    +

    Similarly, this function signature could also be flattened, but is not, due to the persistent line break between the opening ( and the first parameter, ....

    case_when <- function(
   ...,
   .default = NULL,
@@ -328,7 +328,7 @@ 
    ignore-magic-line-
 ) {
   body
 }
    -

    To request flattening in these cases, just remove the magic line break. For example:

    +

    To request flattening in these cases, just remove the persistent line break. For example:

    # If you started here,
 dictionary <- list(
   apple = 0.75,
@@ -344,8 +344,8 @@ 
    ignore-magic-line-
 
 # to get this.
 dictionary <- list(apple = 0.75, banana = 0.25, cherry = 0.50)
    -

    Alternatively, use a tool such as codegrip bound to a keyboard shortcut to flatten the code, and air will keep it flattened as long as it fits within the line-width.

    -

    It may be preferable to ignore magic line breaks if you prefer that line-width should be the only value that influences line breaks.

    +

    Alternatively, use a tool such as codegrip bound to a keyboard shortcut to flatten the code, and Air will keep it flattened as long as it fits within the line-width.

    +

    It may be preferable to ignore persistent line breaks if you prefer that line-width should be the only value that influences line breaks.

    diff --git a/search.json b/search.json index 80099d5b..5db140b2 100644 --- a/search.json +++ b/search.json @@ -14,7 +14,7 @@ "href": "configuration.html#example-configuration", "title": "Configuration", "section": "Example configuration", - "text": "Example configuration\nBelow is a complete air.toml file showing all available options set to their default values:\n[format]\nline-width = 80\nindent-width = 2\nindent-style = \"space\"\nline-ending = \"auto\"\nignore-magic-line-break = false", + "text": "Example configuration\nBelow is a complete air.toml file showing all available options set to their default values:\n[format]\nline-width = 80\nindent-width = 2\nindent-style = \"space\"\nline-ending = \"auto\"\npersistent-line-breaks = true", "crumbs": [ "Configuration" ] @@ -64,7 +64,7 @@ "href": "configuration.html#format-options", "title": "Configuration", "section": "Format options", - "text": "Format options\nAll formatting options are specified under the [format] table.\n\nline-width\nThe preferred maximum line length.\nAn integer value between 1 and 320, with a default of 80.\nWhile the formatter will attempt to format lines such that they remain within the line-width, it isn’t a hard upper bound, and formatted lines may exceed the line-width.\n\n\nindent-width\nThe number of spaces per indentation level.\nAn integer value between 1 and 24, with a default of 2.\nThis option changes the number of spaces the formatter inserts when using indent-style = \"space\". It also represents the width of a tab when indent-style = \"tab\" for the purposes of computing the line-width.\n\n\nindent-style\nWhether to use spaces or tabs for indentation.\nOne of the following values, with a default of \"space\":\n\n\"space\": Use spaces for indentation.\n\"tab\": Use tabs for indentation.\n\nAir defaults to spaces due to the overwhelming amount of existing R code written in this style, but consider using tabs for new projects to improve accessibility. See indent-width to configure the number of spaces per indentation and the tab width.\n\n\nline-ending\nThe character air uses at the end of a line.\nOne of the following values, with a default of \"auto\":\n\n\"auto\": The newline style is detected automatically on a file per file basis. Files with mixed line endings will be converted to the first detected line ending. Defaults to \\n for files that contain no line endings.\n\"lf\": Line endings will be converted to \\n. The typical line ending on Unix.\n\"crlf\": Line endings will be converted to \\r\\n. The typical line ending on Windows.\n\"native\": Line endings will be converted to \\n on Unix and \\r\\n on Windows.\n\n\n\nignore-magic-line-break\nWhether or not magic line breaks should be ignored.\nEither true to ignore magic line breaks, or false to respect them, with a default of false.\nAir respects a small set of magic line breaks as an indication that certain function calls or function signatures should be left expanded. For example, the following list could be flattened to one line and would still fit within a line-width of 80, however, it remains expanded due to the magic line break between the opening ( and the first argument, apple.\ndictionary <- list(\n apple = 0.75,\n banana = 0.25,\n cherry = 0.50\n)\nSimilarly, this function signature could also be flattened, but is not, due to the magic line break between the opening ( and the first parameter, ....\ncase_when <- function(\n ...,\n .default = NULL,\n .ptype = NULL,\n .size = NULL\n) {\n body\n}\nTo request flattening in these cases, just remove the magic line break. For example:\n# If you started here,\ndictionary <- list(\n apple = 0.75,\n banana = 0.25,\n cherry = 0.50\n)\n\n# then do this, and run air,\ndictionary <- list(apple = 0.75,\n banana = 0.25,\n cherry = 0.50\n)\n\n# to get this.\ndictionary <- list(apple = 0.75, banana = 0.25, cherry = 0.50)\nAlternatively, use a tool such as codegrip bound to a keyboard shortcut to flatten the code, and air will keep it flattened as long as it fits within the line-width.\nIt may be preferable to ignore magic line breaks if you prefer that line-width should be the only value that influences line breaks.", + "text": "Format options\nAll formatting options are specified under the [format] table.\n\nline-width\nThe preferred maximum line length.\nAn integer value between 1 and 320, with a default of 80.\nWhile the formatter will attempt to format lines such that they remain within the line-width, it isn’t a hard upper bound, and formatted lines may exceed the line-width.\n\n\nindent-width\nThe number of spaces per indentation level.\nAn integer value between 1 and 24, with a default of 2.\nThis option changes the number of spaces the formatter inserts when using indent-style = \"space\". It also represents the width of a tab when indent-style = \"tab\" for the purposes of computing the line-width.\n\n\nindent-style\nWhether to use spaces or tabs for indentation.\nOne of the following values, with a default of \"space\":\n\n\"space\": Use spaces for indentation.\n\"tab\": Use tabs for indentation.\n\nAir defaults to spaces due to the overwhelming amount of existing R code written in this style, but consider using tabs for new projects to improve accessibility. See indent-width to configure the number of spaces per indentation and the tab width.\n\n\nline-ending\nThe character air uses at the end of a line.\nOne of the following values, with a default of \"auto\":\n\n\"auto\": The newline style is detected automatically on a file per file basis. Files with mixed line endings will be converted to the first detected line ending. Defaults to \\n for files that contain no line endings.\n\"lf\": Line endings will be converted to \\n. The typical line ending on Unix.\n\"crlf\": Line endings will be converted to \\r\\n. The typical line ending on Windows.\n\"native\": Line endings will be converted to \\n on Unix and \\r\\n on Windows.\n\n\n\npersistent-line-breaks\nWhether or not persistent line breaks are allowed.\nEither true to respect persistent line breaks, or false to ignore them, with a default of true.\nAir respects a small set of persistent line breaks as an indication that certain function calls or function signatures should be left expanded. For example, the following list could be flattened to one line and would still fit within a line-width of 80, however, it remains expanded due to the persistent line break between the opening ( and the first argument, apple.\ndictionary <- list(\n apple = 0.75,\n banana = 0.25,\n cherry = 0.50\n)\nSimilarly, this function signature could also be flattened, but is not, due to the persistent line break between the opening ( and the first parameter, ....\ncase_when <- function(\n ...,\n .default = NULL,\n .ptype = NULL,\n .size = NULL\n) {\n body\n}\nTo request flattening in these cases, just remove the persistent line break. For example:\n# If you started here,\ndictionary <- list(\n apple = 0.75,\n banana = 0.25,\n cherry = 0.50\n)\n\n# then do this, and run air,\ndictionary <- list(apple = 0.75,\n banana = 0.25,\n cherry = 0.50\n)\n\n# to get this.\ndictionary <- list(apple = 0.75, banana = 0.25, cherry = 0.50)\nAlternatively, use a tool such as codegrip bound to a keyboard shortcut to flatten the code, and Air will keep it flattened as long as it fits within the line-width.\nIt may be preferable to ignore persistent line breaks if you prefer that line-width should be the only value that influences line breaks.", "crumbs": [ "Configuration" ] diff --git a/sitemap.xml b/sitemap.xml index 3c2c6b4a..73e2b8c8 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,22 +2,22 @@ https://posit-dev.github.io/air/configuration.html - 2025-01-17T15:33:43.902Z + 2025-01-17T16:10:22.068Z https://posit-dev.github.io/air/formatter.html - 2025-01-17T15:33:43.902Z + 2025-01-17T16:10:22.068Z https://posit-dev.github.io/air/editors.html - 2025-01-17T15:33:43.902Z + 2025-01-17T16:10:22.068Z https://posit-dev.github.io/air/index.html - 2025-01-17T15:33:43.905Z + 2025-01-17T16:10:22.071Z https://posit-dev.github.io/air/installation.html - 2025-01-17T15:33:43.905Z + 2025-01-17T16:10:22.071Z