Built site for gh-pages

.nojekyll

@@ -1 +1 @@
-6ac75c38
+3a700d9d

docs_issues.html

@@ -247,10 +247,13 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#details" id="toc-details" class="nav-link" data-scroll-target="#details">Details</a></li>
   </ul></li>
   </ul></li>
-  <li><a href="#issue-2" id="toc-issue-2" class="nav-link" data-scroll-target="#issue-2">Issue 2</a>
+  <li><a href="#repeated-rejections-of-issues-in-manuals-if-using-roxygen2" id="toc-repeated-rejections-of-issues-in-manuals-if-using-roxygen2" class="nav-link" data-scroll-target="#repeated-rejections-of-issues-in-manuals-if-using-roxygen2">Repeated Rejections of Issues in Manuals If Using ‘roxygen2’</a>
   <ul class="collapse">
   <li><a href="#problem-1" id="toc-problem-1" class="nav-link" data-scroll-target="#problem-1">Problem</a></li>
-  <li><a href="#solution-1" id="toc-solution-1" class="nav-link" data-scroll-target="#solution-1">Solution</a></li>
+  <li><a href="#solution-1" id="toc-solution-1" class="nav-link" data-scroll-target="#solution-1">Solution</a>
+  <ul class="collapse">
+  <li><a href="#details-1" id="toc-details-1" class="nav-link" data-scroll-target="#details-1">Details</a></li>
+  </ul></li>
   </ul></li>
   <li><a href="#issue-3" id="toc-issue-3" class="nav-link" data-scroll-target="#issue-3">Issue 3</a>
   <ul class="collapse">
@@ -297,24 +300,54 @@ <h3 class="anchored" data-anchor-id="details">Details</h3>
 <p>Adding 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.</p>
 <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="cell">
-<div class="sourceCode cell-code" id="cb1"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>\value{No return value, called <span class="cf">for</span> side effects}</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-</div>
+<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>
-<div class="cell">
-<div class="sourceCode cell-code" id="cb2"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="co">#' @return What your function returns.</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
-</div>
-<p>For more details on ‘roxygen2’ check the ‘roxygen2’ section.</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>
 </section>
 </section>
 </section>
-<section id="issue-2" class="level1">
-<h1>Issue 2</h1>
+<section id="repeated-rejections-of-issues-in-manuals-if-using-roxygen2" class="level1">
+<h1>Repeated Rejections of Issues in Manuals If Using ‘roxygen2’</h1>
 <section id="problem-1" class="level2">
 <h2 class="anchored" data-anchor-id="problem-1">Problem</h2>
+<p>The CRAN team rejected your package for issues regarding the manuals a second time, even if you already changed them according to their suggestions.</p>
 </section>
 <section id="solution-1" class="level2">
 <h2 class="anchored" data-anchor-id="solution-1">Solution</h2>
+<p>Implement your changes in the corresponding .R-files instead of the .Rd-files. Before resubmitting render the .Rd-files again using <code>roxygenize()</code>.</p>
+<section id="details-1" class="level3">
+<h3 class="anchored" data-anchor-id="details-1">Details</h3>
+<p>If you decide to render your manuals with <a href="https://cran.r-project.org/web/packages/roxygen2/index.html">‘roxygen2’</a>, the .Rd-files can be render using the function <a href="https://roxygen2.r-lib.org/reference/roxygenize.html"><code>roxygenize()</code></a>. If changes are implemented directly in the .Rd-file, they will be overwritten during the next render. Similarly, changes in the ‘roxygen2’-section of .R-files will not transfer to the .Rd-files without a re-rendering.</p>
+<div class="callout callout-style-default callout-tip callout-titled">
+<div class="callout-header d-flex align-content-center">
+<div class="callout-icon-container">
+<i class="callout-icon"></i>
+</div>
+<div class="callout-title-container flex-fill">
+Tip
+</div>
+</div>
+<div class="callout-body-container callout-body">
+<p>To avoid this mistake, make sure to <strong>always</strong> call <code>roxygenize()</code> before submitting your package.</p>
+</div>
+</div>
+<p>If you want to know more on how to use ‘roxygen2’ to create your manuals, take a look at their <a href="https://roxygen2.r-lib.org/index.html">website</a>.</p>
+<div class="callout callout-style-default callout-note callout-titled">
+<div class="callout-header d-flex align-content-center">
+<div class="callout-icon-container">
+<i class="callout-icon"></i>
+</div>
+<div class="callout-title-container flex-fill">
+Note
+</div>
+</div>
+<div class="callout-body-container callout-body">
+<p>When using ‘devtools’, the function <a href="https://www.rdocumentation.org/packages/devtools/versions/2.4.5/topics/document"><code>devtools::document()</code></a> acts as a wrapper for <code>roxygenize()</code> and can be used to render the .Rd-files.</p>
+</div>
+</div>
+</section>
 </section>
 </section>
 <section id="issue-3" class="level1">

search.json

@@ -4,7 +4,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\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\n\\value{No return value, called for side effects}\n\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\n#' @return What your function returns.\n\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\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.",
     "crumbs": [
       "Manuals & Documentation Issues",
       "Manuals & Documentation Issues"
@@ -26,7 +26,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\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\n\\value{No return value, called for side effects}\n\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\n#' @return What your function returns.\n\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\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.",
     "crumbs": [
       "Manuals & Documentation Issues",
       "Manuals & Documentation Issues"
@@ -37,7 +37,7 @@
     "href": "docs_issues.html#problem-1",
     "title": "Manuals & Documentation Issues",
     "section": "Problem",
-    "text": "Problem",
+    "text": "Problem\nThe CRAN team rejected your package for issues regarding the manuals a second time, even if you already changed them according to their suggestions.",
     "crumbs": [
       "Manuals & Documentation Issues",
       "Manuals & Documentation Issues"
@@ -48,7 +48,7 @@
     "href": "docs_issues.html#solution-1",
     "title": "Manuals & Documentation Issues",
     "section": "Solution",
-    "text": "Solution",
+    "text": "Solution\nImplement your changes in the corresponding .R-files instead of the .Rd-files. Before resubmitting render the .Rd-files again using roxygenize().\n\nDetails\nIf you decide to render your manuals with ‘roxygen2’, the .Rd-files can be render using the function roxygenize(). If changes are implemented directly in the .Rd-file, they will be overwritten during the next render. Similarly, changes in the ‘roxygen2’-section of .R-files will not transfer to the .Rd-files without a re-rendering.\n\n\n\n\n\n\nTip\n\n\n\nTo avoid this mistake, make sure to always call roxygenize() before submitting your package.\n\n\nIf you want to know more on how to use ‘roxygen2’ to create your manuals, take a look at their website.\n\n\n\n\n\n\nNote\n\n\n\nWhen using ‘devtools’, the function devtools::document() acts as a wrapper for roxygenize() and can be used to render the .Rd-files.",
     "crumbs": [
       "Manuals & Documentation Issues",
       "Manuals & Documentation Issues"

sitemap.xml

@@ -2,15 +2,15 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
     <loc>https://r-devel.github.io/cran-cookbook/docs_issues.html</loc>
-    <lastmod>2024-06-27T15:03:59.375Z</lastmod>
+    <lastmod>2024-07-18T13:32:44.105Z</lastmod>
   </url>
   <url>
     <loc>https://r-devel.github.io/cran-cookbook/index.html</loc>
     <lastmod>2024-06-27T15:03:59.376Z</lastmod>
   </url>
   <url>
     <loc>https://r-devel.github.io/cran-cookbook/description_issues.html</loc>
-    <lastmod>2024-07-12T17:37:29.442Z</lastmod>
+    <lastmod>2024-07-18T13:32:40.149Z</lastmod>
   </url>
   <url>
     <loc>https://r-devel.github.io/cran-cookbook/general_issues.html</loc>