Built site for gh-pages

.nojekyll

@@ -1 +1 @@
-41066870
+2466d3be

configuration.html

@@ -197,7 +197,7 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#indent-width" id="toc-indent-width" class="nav-link" data-scroll-target="#indent-width">indent-width</a></li>
   <li><a href="#indent-style" id="toc-indent-style" class="nav-link" data-scroll-target="#indent-style">indent-style</a></li>
   <li><a href="#line-ending" id="toc-line-ending" class="nav-link" data-scroll-target="#line-ending">line-ending</a></li>
-  <li><a href="#ignore-magic-line-break" id="toc-ignore-magic-line-break" class="nav-link" data-scroll-target="#ignore-magic-line-break">ignore-magic-line-break</a></li>
+  <li><a href="#persistent-line-breaks" id="toc-persistent-line-breaks" class="nav-link" data-scroll-target="#persistent-line-breaks">persistent-line-breaks</a></li>
   </ul></li>
   </ul>
 </nav>
@@ -233,7 +233,7 @@ <h2 class="anchored" data-anchor-id="example-configuration">Example configuratio
 <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="dt">indent-width</span> <span class="op">=</span> <span class="dv">2</span></span>
 <span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="dt">indent-style</span> <span class="op">=</span> <span class="st">"space"</span></span>
 <span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="dt">line-ending</span> <span class="op">=</span> <span class="st">"auto"</span></span>
-<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="dt">ignore-magic-line-break</span> <span class="op">=</span> <span class="cn">false</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="dt">persistent-line-breaks</span> <span class="op">=</span> <span class="cn">true</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </section>
 <section id="configuration-recommendations" class="level2">
 <h2 class="anchored" data-anchor-id="configuration-recommendations">Configuration recommendations</h2>
@@ -309,17 +309,17 @@ <h3 class="anchored" data-anchor-id="line-ending">line-ending</h3>
 <li><p><code>"native"</code>: Line endings will be converted to <code>\n</code> on Unix and <code>\r\n</code> on Windows.</p></li>
 </ul>
 </section>
-<section id="ignore-magic-line-break" class="level3">
-<h3 class="anchored" data-anchor-id="ignore-magic-line-break">ignore-magic-line-break</h3>
-<p>Whether or not magic line breaks should be ignored.</p>
-<p>Either <code>true</code> to ignore magic line breaks, or <code>false</code> to respect them, with a default of <code>false</code>.</p>
-<p>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 <code>line-width</code> of 80, however, it remains expanded due to the magic line break between the opening <code>(</code> and the first argument, <code>apple</code>.</p>
+<section id="persistent-line-breaks" class="level3">
+<h3 class="anchored" data-anchor-id="persistent-line-breaks">persistent-line-breaks</h3>
+<p>Whether or not persistent line breaks are allowed.</p>
+<p>Either <code>true</code> to respect persistent line breaks, or <code>false</code> to ignore them, with a default of <code>true</code>.</p>
+<p>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 <code>line-width</code> of 80, however, it remains expanded due to the persistent line break between the opening <code>(</code> and the first argument, <code>apple</code>.</p>
 <div class="sourceCode" id="cb3"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a>dictionary <span class="ot">&lt;-</span> <span class="fu">list</span>(</span>
 <span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>  <span class="at">apple =</span> <span class="fl">0.75</span>,</span>
 <span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a>  <span class="at">banana =</span> <span class="fl">0.25</span>,</span>
 <span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a>  <span class="at">cherry =</span> <span class="fl">0.50</span></span>
 <span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-<p>Similarly, this function signature could also be flattened, but is not, due to the magic line break between the opening <code>(</code> and the first parameter, <code>...</code>.</p>
+<p>Similarly, this function signature could also be flattened, but is not, due to the persistent line break between the opening <code>(</code> and the first parameter, <code>...</code>.</p>
 <div class="sourceCode" id="cb4"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>case_when <span class="ot">&lt;-</span> <span class="cf">function</span>(</span>
 <span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a>  ...,</span>
 <span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a>  <span class="at">.default =</span> <span class="cn">NULL</span>,</span>
@@ -328,7 +328,7 @@ <h3 class="anchored" data-anchor-id="ignore-magic-line-break">ignore-magic-line-
 <span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a>) {</span>
 <span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a>  body</span>
 <span id="cb4-8"><a href="#cb4-8" aria-hidden="true" tabindex="-1"></a>}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-<p>To request flattening in these cases, just remove the magic line break. For example:</p>
+<p>To request flattening in these cases, just remove the persistent line break. For example:</p>
 <div class="sourceCode" id="cb5"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="co"># If you started here,</span></span>
 <span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a>dictionary <span class="ot">&lt;-</span> <span class="fu">list</span>(</span>
 <span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a>  <span class="at">apple =</span> <span class="fl">0.75</span>,</span>
@@ -344,8 +344,8 @@ <h3 class="anchored" data-anchor-id="ignore-magic-line-break">ignore-magic-line-
 <span id="cb5-13"><a href="#cb5-13" aria-hidden="true" tabindex="-1"></a></span>
 <span id="cb5-14"><a href="#cb5-14" aria-hidden="true" tabindex="-1"></a><span class="co"># to get this.</span></span>
 <span id="cb5-15"><a href="#cb5-15" aria-hidden="true" tabindex="-1"></a>dictionary <span class="ot">&lt;-</span> <span class="fu">list</span>(<span class="at">apple =</span> <span class="fl">0.75</span>, <span class="at">banana =</span> <span class="fl">0.25</span>, <span class="at">cherry =</span> <span class="fl">0.50</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-<p>Alternatively, use a tool such as <a href="https://github.com/lionel-/codegrip">codegrip</a> bound to a keyboard shortcut to flatten the code, and air will keep it flattened as long as it fits within the <code>line-width</code>.</p>
-<p>It may be preferable to ignore magic line breaks if you prefer that <code>line-width</code> should be the only value that influences line breaks.</p>
+<p>Alternatively, use a tool such as <a href="https://github.com/lionel-/codegrip">codegrip</a> bound to a keyboard shortcut to flatten the code, and Air will keep it flattened as long as it fits within the <code>line-width</code>.</p>
+<p>It may be preferable to ignore persistent line breaks if you prefer that <code>line-width</code> should be the only value that influences line breaks.</p>
 
 
 </section>

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"
     ]

sitemap.xml

@@ -2,22 +2,22 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://posit-dev.github.io/air/configuration.html</loc>
-    <lastmod>2025-01-17T15:33:43.902Z</lastmod>
+    <lastmod>2025-01-17T16:10:22.068Z</lastmod>
   </url>
   <url>
     <loc>https://posit-dev.github.io/air/formatter.html</loc>
-    <lastmod>2025-01-17T15:33:43.902Z</lastmod>
+    <lastmod>2025-01-17T16:10:22.068Z</lastmod>
   </url>
   <url>
     <loc>https://posit-dev.github.io/air/editors.html</loc>
-    <lastmod>2025-01-17T15:33:43.902Z</lastmod>
+    <lastmod>2025-01-17T16:10:22.068Z</lastmod>
   </url>
   <url>
     <loc>https://posit-dev.github.io/air/index.html</loc>
-    <lastmod>2025-01-17T15:33:43.905Z</lastmod>
+    <lastmod>2025-01-17T16:10:22.071Z</lastmod>
   </url>
   <url>
     <loc>https://posit-dev.github.io/air/installation.html</loc>
-    <lastmod>2025-01-17T15:33:43.905Z</lastmod>
+    <lastmod>2025-01-17T16:10:22.071Z</lastmod>
   </url>
 </urlset>