[DO NOT MERGE] Add a broken docstring

.github/workflows/PR.yml

@@ -50,17 +50,6 @@ jobs:
         cd $GITHUB_WORKSPACE/hammerspoon
         /usr/bin/python3 -m pip install -r requirements.txt
 
-    # If this is a PR, capture its number
-    - name: Capture PR number
-      if: github.event_name == 'pull_request'
-      run: echo ${GITHUB_REF} | awk 'BEGIN { FS = "/" } ; { print $3 }' >pr_num.txt
-    - name: Upload PR number
-      if: github.event_name == 'pull_request'
-      uses: actions/upload-artifact@v2
-      with:
-        name: pr_num.txt
-        path: pr_num.txt
-
     # Find files modified by this PR
     - uses: lots0logs/gh-action-get-changed-files@2.1.4
       with:
@@ -74,22 +63,6 @@ jobs:
     - name: Docstrings Linter
       run: ./gh_actions_doclint.sh
 
-    # Store docstrings linter annotations as an artifact
-    - name: Upload linter artifacts
-      if: always()
-      uses: actions/upload-artifact@v2
-      with:
-        name: annotations.json
-        path: annotations.json
-
-    # NOTE: This will fail on third party PRs, until https://github.com/yuzutech/annotations-action/issues/23 is implemented
-    #- name: Publish Docstring Annotations
-    #  uses: yuzutech/annotations-action@v0.3.0
-    #  with:
-    #    repo-token: "${{ secrets.GITHUB_TOKEN }}"
-    #    title: "Docstrings linter"
-    #    input: annotations.json
-
     # Fail CI run if docstrings failed
     - name: Check for docstring lint failures
       run: ./gh_actions_doclint.sh -v

Source/Seal.spoon/init.lua

@@ -49,6 +49,7 @@ obj.plugin_search_paths = { hs.configdir .. "/seal_plugins", obj.spoonPath }
 --- Seal:refreshCommandsForPlugin(plugin_name)
 --- Method
 --- Refresh the list of commands provided by the given plugin.
+--- This ought to generate a lint error
 ---
 --- Parameters:
 ---  * plugin_name - the name of the plugin. Should be the name as passed to `loadPlugins()` or `loadPluginFromFile`.