Skip to content

Commit 71a4068

Browse files
author
Jasmine Daly
committed
Built site for gh-pages
1 parent 5eea4b1 commit 71a4068

File tree

5 files changed

+115
-5
lines changed

5 files changed

+115
-5
lines changed

‎.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3a700d9d
1+
0240d628

‎description_issues.html

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,22 @@ <h2 id="toc-title">On this page</h2>
213213
<li><a href="#details" id="toc-details" class="nav-link" data-scroll-target="#details">Details</a></li>
214214
</ul></li>
215215
</ul></li>
216+
<li><a href="#explaining-acronyms" id="toc-explaining-acronyms" class="nav-link" data-scroll-target="#explaining-acronyms">Explaining Acronyms</a>
217+
<ul class="collapse">
218+
<li><a href="#problem-1" id="toc-problem-1" class="nav-link" data-scroll-target="#problem-1">Problem</a></li>
219+
<li><a href="#solution-1" id="toc-solution-1" class="nav-link" data-scroll-target="#solution-1">Solution</a>
220+
<ul class="collapse">
221+
<li><a href="#details-1" id="toc-details-1" class="nav-link" data-scroll-target="#details-1">Details</a></li>
222+
</ul></li>
223+
</ul></li>
224+
<li><a href="#license-files" id="toc-license-files" class="nav-link" data-scroll-target="#license-files">LICENSE files</a>
225+
<ul class="collapse">
226+
<li><a href="#problem-2" id="toc-problem-2" class="nav-link" data-scroll-target="#problem-2">Problem</a></li>
227+
<li><a href="#solution-2" id="toc-solution-2" class="nav-link" data-scroll-target="#solution-2">Solution</a>
228+
<ul class="collapse">
229+
<li><a href="#details-2" id="toc-details-2" class="nav-link" data-scroll-target="#details-2">Details</a></li>
230+
</ul></li>
231+
</ul></li>
216232
</ul>
217233
</nav>
218234
</div>
@@ -255,6 +271,50 @@ <h3 class="anchored" data-anchor-id="details">Details</h3>
255271
read rectangular data (like 'csv', 'tsv', and 'fwf'). It is designed
256272
to flexibly parse many types of data found in the wild, while still
257273
cleanly failing when data unexpectedly changes.</code></pre>
274+
</section>
275+
</section>
276+
</section>
277+
<section id="explaining-acronyms" class="level1">
278+
<h1>Explaining Acronyms</h1>
279+
<section id="problem-1" class="level2">
280+
<h2 class="anchored" data-anchor-id="problem-1">Problem</h2>
281+
<p>You are using acronyms in your DESCRIPTION file or they are flagged by the automatic spell check.</p>
282+
</section>
283+
<section id="solution-1" class="level2">
284+
<h2 class="anchored" data-anchor-id="solution-1">Solution</h2>
285+
<p>Document all non-obvious acronyms in the <a href="https://usethis.r-lib.org/reference/use_cran_comments.html">cran-comments.md</a> file to facilitate the CRAN team review.</p>
286+
<section id="details-1" class="level3">
287+
<h3 class="anchored" data-anchor-id="details-1">Details</h3>
288+
<p>Most acronyms that are not widely known should be explained. For example, you don’t have to explain <em>OLS</em>, <em>SEO</em>, or <em>DNA</em> but explanations should be provided for: <em>MEFM</em> or <em>OCCDS</em>. If you are unsure of the acronyms common knowledge, please document all acronyms in the package.</p>
289+
</section>
290+
</section>
291+
</section>
292+
<section id="license-files" class="level1">
293+
<h1>LICENSE files</h1>
294+
<p>Same goes for MIT-License files with wrongly specified copyright holders. Surprisingly often, package authors write “[packagename] authors” (which is fine) but still list an old/outdated packagename.</p>
295+
<section id="problem-2" class="level2">
296+
<h2 class="anchored" data-anchor-id="problem-2">Problem</h2>
297+
<p>A file is referenced in the DESCRIPTION for License.</p>
298+
</section>
299+
<section id="solution-2" class="level2">
300+
<h2 class="anchored" data-anchor-id="solution-2">Solution</h2>
301+
<p>Remove the reference <code>+ file LICENSE</code></p>
302+
<section id="details-2" class="level3">
303+
<h3 class="anchored" data-anchor-id="details-2">Details</h3>
304+
<p>Most licenses don’t need an additional file as these are part of R.</p>
305+
<div class="callout callout-style-default callout-tip callout-titled">
306+
<div class="callout-header d-flex align-content-center">
307+
<div class="callout-icon-container">
308+
<i class="callout-icon"></i>
309+
</div>
310+
<div class="callout-title-container flex-fill">
311+
Tip
312+
</div>
313+
</div>
314+
<div class="callout-body-container callout-body">
315+
<p>All licenses must be <a href="https://svn.r-project.org/R/trunk/share/licenses/license.db">FOSS</a>.</p>
316+
</div>
317+
</div>
258318

259319

260320
</section>

‎search.json

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,50 @@
119119
"DESCRIPTION file Issues"
120120
]
121121
},
122+
{
123+
"objectID": "description_issues.html#problem-1",
124+
"href": "description_issues.html#problem-1",
125+
"title": "DESCRIPTION file Issues",
126+
"section": "Problem",
127+
"text": "Problem\nYou are using acronyms in your DESCRIPTION file or they are flagged by the automatic spell check.",
128+
"crumbs": [
129+
"DESCRIPTION file Issues",
130+
"DESCRIPTION file Issues"
131+
]
132+
},
133+
{
134+
"objectID": "description_issues.html#solution-1",
135+
"href": "description_issues.html#solution-1",
136+
"title": "DESCRIPTION file Issues",
137+
"section": "Solution",
138+
"text": "Solution\nDocument all non-obvious acronyms in the cran-comments.md file to facilitate the CRAN team review.\n\nDetails\nMost acronyms that are not widely known should be explained. For example, you don’t have to explain OLS, SEO, or DNA but explanations should be provided for: MEFM or OCCDS. If you are unsure of the acronyms common knowledge, please document all acronyms in the package.",
139+
"crumbs": [
140+
"DESCRIPTION file Issues",
141+
"DESCRIPTION file Issues"
142+
]
143+
},
144+
{
145+
"objectID": "description_issues.html#problem-2",
146+
"href": "description_issues.html#problem-2",
147+
"title": "DESCRIPTION file Issues",
148+
"section": "Problem",
149+
"text": "Problem\nA file is referenced in the DESCRIPTION for License.",
150+
"crumbs": [
151+
"DESCRIPTION file Issues",
152+
"DESCRIPTION file Issues"
153+
]
154+
},
155+
{
156+
"objectID": "description_issues.html#solution-2",
157+
"href": "description_issues.html#solution-2",
158+
"title": "DESCRIPTION file Issues",
159+
"section": "Solution",
160+
"text": "Solution\nRemove the reference + file LICENSE\n\nDetails\nMost licenses don’t need an additional file as these are part of R.\n\n\n\n\n\n\nTip\n\n\n\nAll licenses must be FOSS.",
161+
"crumbs": [
162+
"DESCRIPTION file Issues",
163+
"DESCRIPTION file Issues"
164+
]
165+
},
122166
{
123167
"objectID": "general_issues.html",
124168
"href": "general_issues.html",

‎sitemap.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://r-devel.github.io/cran-cookbook/docs_issues.html</loc>
5-
<lastmod>2024-07-18T13:32:44.105Z</lastmod>
5+
<lastmod>2024-07-25T22:24:02.874Z</lastmod>
66
</url>
77
<url>
88
<loc>https://r-devel.github.io/cran-cookbook/index.html</loc>
99
<lastmod>2024-06-27T15:03:59.376Z</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://r-devel.github.io/cran-cookbook/description_issues.html</loc>
13-
<lastmod>2024-07-18T13:32:40.149Z</lastmod>
13+
<lastmod>2024-07-25T22:40:01.712Z</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://r-devel.github.io/cran-cookbook/general_issues.html</loc>
17-
<lastmod>2024-06-27T15:03:59.376Z</lastmod>
17+
<lastmod>2024-07-25T22:24:02.874Z</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://r-devel.github.io/cran-cookbook/code_issues.html</loc>
21-
<lastmod>2024-06-27T15:03:59.374Z</lastmod>
21+
<lastmod>2024-07-25T22:24:02.873Z</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://r-devel.github.io/cran-cookbook/about.html</loc>

‎style.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
hr {
2+
border: none;
3+
height: 5px;
4+
color: blue;
5+
background-color: blue;
6+
}

0 commit comments

Comments
 (0)