Built site for gh-pages

.nojekyll

@@ -1 +1 @@
-8c77066f
+527ef511

docs_issues.html

@@ -292,7 +292,7 @@ <h3 class="anchored" data-anchor-id="details">Details</h3>
 <p>The only exception are .Rd-files for data sets, marked with the <code>\docType{data}</code>-tag. Since these are no functions, no <code>\value</code>-tag is necessary.</p>
 <p>Sometimes functions don’t return one specific value but are rather called for their side effects. In that case the <code>\value</code>-tag should state this.</p>
 <div class="sourceCode" id="cb1"><pre class="sourceCode default code-with-copy"><code class="sourceCode default"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>\value{No return value, called for side effects}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-<p>When using ‘roxygen’ to render the .Rd-files, an <code>@return</code>-tag must be added in the corresponding .R-file. This will create the <code>\value</code>-tag automatically when rendering.</p>
+<p>When using ‘roxygen2’ to render the .Rd-files, an <code>@return</code>-tag must be added in the corresponding .R-file. This will create the <code>\value</code>-tag automatically when rendering.</p>
 <div class="sourceCode" id="cb2"><pre class="sourceCode default code-with-copy"><code class="sourceCode default"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>#' @return What your function returns.</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <p>For more details on ‘roxygen2’ check the <a href="#repeated-rejections-of-issues-in-manuals-if-using-roxygen2">‘roxygen2’ section</a>.</p>
 <hr>

search.json

@@ -374,7 +374,7 @@
     "href": "docs_issues.html",
     "title": "Manuals & Documentation Issues",
     "section": "",
-    "text": "Every .Rd file should have an \\value-tag stating what the output of the function is. Even if nothing is returned, the \\value-tag is necessary for CRAN.\n\n\n\nOften it is enough to simply add the missing \\value-tags. If the function doesn’t return anything, write that as your \\value-tag.\n\n\n\n\n\n\n\n\nCRAN Review Communication\n\n\n\n\n\nPlease add \\value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \\value{No return value, called for side effects} or similar)\n\n\n\nCRAN wants a \\value-tag for every .Rd-file containing info about the structure of the output (class) and also what the output means.\nAdding a short explanation for each function helps users understand effects of the function call. This prevents unexpected outputs and helps to create a better workflow when using the function.\nThe only exception are .Rd-files for data sets, marked with the \\docType{data}-tag. Since these are no functions, no \\value-tag is necessary.\nSometimes functions don’t return one specific value but are rather called for their side effects. In that case the \\value-tag should state this.\n\\value{No return value, called for side effects}\nWhen using ‘roxygen’ to render the .Rd-files, an @return-tag must be added in the corresponding .R-file. This will create the \\value-tag automatically when rendering.\n#' @return What your function returns.\nFor more details on ‘roxygen2’ check the ‘roxygen2’ section.",
+    "text": "Every .Rd file should have an \\value-tag stating what the output of the function is. Even if nothing is returned, the \\value-tag is necessary for CRAN.\n\n\n\nOften it is enough to simply add the missing \\value-tags. If the function doesn’t return anything, write that as your \\value-tag.\n\n\n\n\n\n\n\n\nCRAN Review Communication\n\n\n\n\n\nPlease add \\value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \\value{No return value, called for side effects} or similar)\n\n\n\nCRAN wants a \\value-tag for every .Rd-file containing info about the structure of the output (class) and also what the output means.\nAdding a short explanation for each function helps users understand effects of the function call. This prevents unexpected outputs and helps to create a better workflow when using the function.\nThe only exception are .Rd-files for data sets, marked with the \\docType{data}-tag. Since these are no functions, no \\value-tag is necessary.\nSometimes functions don’t return one specific value but are rather called for their side effects. In that case the \\value-tag should state this.\n\\value{No return value, called for side effects}\nWhen using ‘roxygen2’ to render the .Rd-files, an @return-tag must be added in the corresponding .R-file. This will create the \\value-tag automatically when rendering.\n#' @return What your function returns.\nFor more details on ‘roxygen2’ check the ‘roxygen2’ section.",
     "crumbs": [
       "Manuals & Documentation Issues"
     ]
@@ -394,7 +394,7 @@
     "href": "docs_issues.html#solution",
     "title": "Manuals & Documentation Issues",
     "section": "",
-    "text": "Often it is enough to simply add the missing \\value-tags. If the function doesn’t return anything, write that as your \\value-tag.\n\n\n\n\n\n\n\n\nCRAN Review Communication\n\n\n\n\n\nPlease add \\value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \\value{No return value, called for side effects} or similar)\n\n\n\nCRAN wants a \\value-tag for every .Rd-file containing info about the structure of the output (class) and also what the output means.\nAdding a short explanation for each function helps users understand effects of the function call. This prevents unexpected outputs and helps to create a better workflow when using the function.\nThe only exception are .Rd-files for data sets, marked with the \\docType{data}-tag. Since these are no functions, no \\value-tag is necessary.\nSometimes functions don’t return one specific value but are rather called for their side effects. In that case the \\value-tag should state this.\n\\value{No return value, called for side effects}\nWhen using ‘roxygen’ to render the .Rd-files, an @return-tag must be added in the corresponding .R-file. This will create the \\value-tag automatically when rendering.\n#' @return What your function returns.\nFor more details on ‘roxygen2’ check the ‘roxygen2’ section.",
+    "text": "Often it is enough to simply add the missing \\value-tags. If the function doesn’t return anything, write that as your \\value-tag.\n\n\n\n\n\n\n\n\nCRAN Review Communication\n\n\n\n\n\nPlease add \\value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \\value{No return value, called for side effects} or similar)\n\n\n\nCRAN wants a \\value-tag for every .Rd-file containing info about the structure of the output (class) and also what the output means.\nAdding a short explanation for each function helps users understand effects of the function call. This prevents unexpected outputs and helps to create a better workflow when using the function.\nThe only exception are .Rd-files for data sets, marked with the \\docType{data}-tag. Since these are no functions, no \\value-tag is necessary.\nSometimes functions don’t return one specific value but are rather called for their side effects. In that case the \\value-tag should state this.\n\\value{No return value, called for side effects}\nWhen using ‘roxygen2’ to render the .Rd-files, an @return-tag must be added in the corresponding .R-file. This will create the \\value-tag automatically when rendering.\n#' @return What your function returns.\nFor more details on ‘roxygen2’ check the ‘roxygen2’ section.",
     "crumbs": [
       "Manuals & Documentation Issues"
     ]

sitemap.xml

@@ -2,30 +2,30 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/general_issues.html</loc>
-    <lastmod>2024-11-19T19:47:42.491Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.570Z</lastmod>
   </url>
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/resources.html</loc>
-    <lastmod>2024-11-19T19:47:42.499Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.574Z</lastmod>
   </url>
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/code_issues.html</loc>
-    <lastmod>2024-11-19T19:47:42.491Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.570Z</lastmod>
   </url>
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/description_issues.html</loc>
-    <lastmod>2024-11-19T19:47:42.491Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.570Z</lastmod>
   </url>
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/preface.html</loc>
-    <lastmod>2024-11-19T19:47:42.495Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.574Z</lastmod>
   </url>
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/docs_issues.html</loc>
-    <lastmod>2024-11-19T19:47:42.491Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.570Z</lastmod>
   </url>
   <url>
     <loc>https://contributor.r-project.org/cran-cookbook/index.html</loc>
-    <lastmod>2024-11-19T19:47:42.491Z</lastmod>
+    <lastmod>2024-11-19T20:46:12.570Z</lastmod>
   </url>
 </urlset>