fixing a bunch of broken stuff I think
This commit is contained in:
parent
0dbc3ead0e
commit
8bace887a2
1551 changed files with 299 additions and 57481 deletions
|
|
@ -1 +0,0 @@
|
|||
<!-- SC_OFF --><div class="md"><p>Screenshot: <a href="https://ibb.co/NyRxFkC">https://ibb.co/NyRxFkC</a></p> <p>Why am I seeing these warnings? Do they matter and why are they appearing?</p> </div><!-- SC_ON -->   submitted by   <a href="https://www.reddit.com/user/Panfinz"> /u/Panfinz </a> <br/> <span><a href="https://www.reddit.com/r/archlinux/comments/r639z9/constantly_getting_these_warnings_while_starting/">[link]</a></span>   <span><a href="https://www.reddit.com/r/archlinux/comments/r639z9/constantly_getting_these_warnings_while_starting/">[comments]</a></span>
|
||||
|
|
@ -1 +0,0 @@
|
|||
<!-- SC_OFF --><div class="md"><p>Sometimes when setting up a new package I get a weird error. Example</p> <p>I try to run:</p> <p><code>(use-package ivy)</code> ("C-x C-e" to evaluate)</p> <p>Result:</p> <p><code>Error (use-package): Failed to install ivy: Wrong type argument: stringp, nil</code></p> <p><code>Error (use-package): Cannot load ivy</code></p> <p>Then, without (knowingly) changing anything it will start to work. I'm convinced emacs just wants to see me scramble to the internet. </p> <p>Has anyone else seen this, or am I living in the twilight zone? Any insight would be appreciated.</p> <p>A bit of context:</p> <p>- This is in my congif.org file</p> <p>- I'm in server mode</p> </div><!-- SC_ON -->   submitted by   <a href="https://www.reddit.com/user/straar"> /u/straar </a> <br/> <span><a href="https://www.reddit.com/r/emacs/comments/rssab9/noob_question_about_usepackage/">[link]</a></span>   <span><a href="https://www.reddit.com/r/emacs/comments/rssab9/noob_question_about_usepackage/">[comments]</a></span>
|
||||
|
|
@ -1 +0,0 @@
|
|||
<!-- SC_OFF --><div class="md"><p>I'd like to align a table of args with their descriptions in a doc string. For example, see the help for the variable <code>align-rules-list</code>. It has a table of keys and their descriptions.</p> <p>I'm trying to use <code>align</code> package to accomplish the same thing but it doesn't seem to be working. I would have figured the built-in rules would have worked but none appear to match that use case. </p> <p>Does anyone have insight on aligning such a table?</p> </div><!-- SC_ON -->   submitted by   <a href="https://www.reddit.com/user/french_pressed"> /u/french_pressed </a> <br/> <span><a href="https://www.reddit.com/r/emacs/comments/r2ys7p/aligning_tables_in_doc_strings/">[link]</a></span>   <span><a href="https://www.reddit.com/r/emacs/comments/r2ys7p/aligning_tables_in_doc_strings/">[comments]</a></span>
|
||||
|
|
@ -1 +0,0 @@
|
|||
<!-- SC_OFF --><div class="md"><p>Hi!</p> <p>These are a few small scripts I use related to Emacs and Org-mode. I recently added some descriptions for each. I hope they are also useful for someone out there.</p> <p><a href="https://github.com/psamim/dotfiles#related-to-emacs-org-mode-or-ledger-cli">https://github.com/psamim/dotfiles#related-to-emacs-org-mode-or-ledger-cli</a></p> <p>Please advise me if you have a better suggestion for any of them!</p> <p>Thanks</p> </div><!-- SC_ON -->   submitted by   <a href="https://www.reddit.com/user/psamim"> /u/psamim </a> <br/> <span><a href="https://www.reddit.com/r/emacs/comments/racj3j/my_scripts_related_to_emacs_and_orgmode/">[link]</a></span>   <span><a href="https://www.reddit.com/r/emacs/comments/racj3j/my_scripts_related_to_emacs_and_orgmode/">[comments]</a></span>
|
||||
|
|
@ -1 +0,0 @@
|
|||
<!-- SC_OFF --><div class="md"><p>Hi! I'm considering getting into Emacs for knowledge management and note-taking using org-mode and org-roam and see how it compares to Obsidian.</p> <p><strong>I have three questions:</strong></p> <ol> <li>How can I use Emacs on mobile and sync across all of my devices? I need cross-platform usability, especially since I plan to use it on both my iPhone and iPad. I've tried Beorg, but it seems like it's only for task management.</li> <li>How can I integrate it with modern apps and services (e.g. Readwise)? This is something that Obsidian has, which I want to implement in Emacs if it's possible.</li> <li>What does Emacs have over Obsidian? Has anyone here switched from Obsidian to Emacs?</li> </ol> <p>Thanks.</p> </div><!-- SC_ON -->   submitted by   <a href="https://www.reddit.com/user/better-vessel"> /u/better-vessel </a> <br/> <span><a href="https://www.reddit.com/r/emacs/comments/q788ib/questions_about_emacs/">[link]</a></span>   <span><a href="https://www.reddit.com/r/emacs/comments/q788ib/questions_about_emacs/">[comments]</a></span>
|
||||
|
|
@ -1,69 +0,0 @@
|
|||
<p>A couple of years ago I wrote an article about <a href="https://metaredux.com/posts/2019/05/24/eradicate-typos-in-source-code.html">dealing with typos in your source code</a>. Today I’ll follow up
|
||||
with a simple recipe to automate this spell-checking process using GitHub Actions (GHA).<sup id="fnref:1"><a class="footnote" href="https://metaredux.com/posts/2021/11/26/automate-spell-checking-in-your-projects-with-github-actions.html#fn:1" rel="footnote">1</a></sup></p>
|
||||
|
||||
<p>Lately I’ve been adding the following <a href="https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions">GHA workflow</a> to all of my OSS projects:</p>
|
||||
|
||||
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">name</span><span class="pi">:</span> <span class="s">Spell Checking</span>
|
||||
|
||||
<span class="na">on</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">pull_request</span><span class="pi">]</span>
|
||||
|
||||
<span class="na">jobs</span><span class="pi">:</span>
|
||||
<span class="na">codespell</span><span class="pi">:</span>
|
||||
<span class="na">name</span><span class="pi">:</span> <span class="s">Check spelling with codespell</span>
|
||||
<span class="na">runs-on</span><span class="pi">:</span> <span class="s">ubuntu-latest</span>
|
||||
<span class="na">strategy</span><span class="pi">:</span>
|
||||
<span class="na">matrix</span><span class="pi">:</span>
|
||||
<span class="na">python-version</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">3.8</span><span class="pi">]</span>
|
||||
<span class="na">steps</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="na">uses</span><span class="pi">:</span> <span class="s">actions/checkout@v2</span>
|
||||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Set up Python $</span>
|
||||
<span class="na">uses</span><span class="pi">:</span> <span class="s">actions/setup-python@v2</span>
|
||||
<span class="na">with</span><span class="pi">:</span>
|
||||
<span class="na">python-version</span><span class="pi">:</span> <span class="s">$</span>
|
||||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Install dependencies</span>
|
||||
<span class="na">run</span><span class="pi">:</span> <span class="pi">|</span>
|
||||
<span class="s">python -m pip install --upgrade pip</span>
|
||||
<span class="s">pip install codespell</span>
|
||||
<span class="s">if [ -f requirements.txt ]; then pip install -r requirements.txt; fi</span>
|
||||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Check spelling with codespell</span>
|
||||
<span class="na">run</span><span class="pi">:</span> <span class="s">codespell --ignore-words=codespell.txt || exit </span><span class="m">1</span>
|
||||
<span class="na">misspell</span><span class="pi">:</span>
|
||||
<span class="na">name</span><span class="pi">:</span> <span class="s">Check spelling with misspell</span>
|
||||
<span class="na">runs-on</span><span class="pi">:</span> <span class="s">ubuntu-latest</span>
|
||||
<span class="na">steps</span><span class="pi">:</span>
|
||||
<span class="pi">-</span> <span class="na">uses</span><span class="pi">:</span> <span class="s">actions/checkout@v2</span>
|
||||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Install</span>
|
||||
<span class="na">run</span><span class="pi">:</span> <span class="s">wget -O - -q https://git.io/misspell | sh -s -- -b .</span>
|
||||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">Misspell</span>
|
||||
<span class="na">run</span><span class="pi">:</span> <span class="s">./misspell -error</span>
|
||||
</code></pre></div></div>
|
||||
|
||||
<p>There’s nothing fancy here. We’re just installing a couple of popular spell-checkers for code and we run them
|
||||
on everything within the Git repository. If they discover any problems the build will fail.</p>
|
||||
|
||||
<p>Just save the code above under <code class="language-plaintext highlighter-rouge">.github/workflows/spell_checking.yml</code> and you’re good to go.
|
||||
The workflow will get triggered for each subsequent pull request.</p>
|
||||
|
||||
<p>A couple of things to note:</p>
|
||||
|
||||
<ul>
|
||||
<li>This workflow uses both <a href="https://github.com/codespell-project/codespell">codespell</a> and <a href="https://github.com/client9/misspell">misspell</a>. Using both might be an overkill for some of you. Personally, I like <code class="language-plaintext highlighter-rouge">misspell</code> more, as it’s super fast.</li>
|
||||
<li>It’s a good idea to run both tools locally first and address any existing typos.</li>
|
||||
<li>You may want to limit the checks only to files that were changed in the pull request.</li>
|
||||
<li>You may want to specify a locale for <code class="language-plaintext highlighter-rouge">misspell</code> if you want to enforce a specific flavor of English (e.g. <code class="language-plaintext highlighter-rouge">misspell -locale US</code>).</li>
|
||||
<li>This should probably be made a <a href="https://docs.github.com/en/actions/learn-github-actions/reusing-workflows">reusable workflow</a>. I won’t be surprised if someone actually has created a public reusable workflow for spell-checking code already.</li>
|
||||
</ul>
|
||||
|
||||
<p>That’s all I have for you today. Big thanks to my fellow OSS hacker <a href="https://github.com/koic">Koichi
|
||||
Ito</a>, who came up with the idea of making
|
||||
spell-checking a CI step. In hindsight it seems like a very obvious thing to do,
|
||||
but it was always an afterthought for me. I’d be curious to hear how others are
|
||||
dealing with typos in their codebases.</p>
|
||||
|
||||
<div class="footnotes">
|
||||
<ol>
|
||||
<li id="fn:1">
|
||||
<p>The outlined approach can easily be adapted for any other CI. <a class="reversefootnote" href="https://metaredux.com/posts/2021/11/26/automate-spell-checking-in-your-projects-with-github-actions.html#fnref:1">↩</a></p>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
Loading…
Add table
Add a link
Reference in a new issue