Clean up bad <CR> fuckery wrt. autocomplete (#66)

Author: LunarWatcher

README.md

@@ -26,7 +26,7 @@ To use experimental changes before they're deployed, use:
 Plug 'LunarWatcher/auto-pairs', {'branch': 'develop'}
 ```
 
-**Note:** As of 4.0.0, `let g:AutoPairsCompatibleMaps = 0` is default. Set the variable to 1 to use jiangmiao-compatible keybinds.
+**Note:** As of 4.0.0, `let g:AutoPairsCompatibleMaps = 0` is the default. Set the variable to 1 to use jiangmiao-compatible keybinds.
 
 ## Running tests (not required)
 
@@ -72,6 +72,7 @@ Functionally, however, it's meant to resemble upstream as much as possible, part
 * ... and with new ones.
 * Increased customizability
 
+
 ## Non-goals
 * Being a drop-in snippet replacement -- use UltiSnips or lexima.vim instead.
 * Supporting very old versions of Vim

doc/AutoPairs.txt

@@ -1179,7 +1179,7 @@ jiangmiao/auto-pairs.
 
 DO NOT MODIFY
 This variable is a constant per version, and exists for compatibility reasons.
-Do not set this variable yourself. This canc and will have unintended
+Do not set this variable yourself. This can and will have unintended
 consequences.
 
 Defines the current version. Note that while this is largely intended to
@@ -1738,7 +1738,7 @@ This function initialises all the global variables auto-pairs uses.
 
 While primarily intended for internal use, it can be used to force load
 auto-pairs' variables. This is more or less entirely intended for object or 
-list variables, where setting the value may override other desired variabels,
+list variables, where setting the value may override other desired variables
 but where the variable doesn't also have a corresponding modifying function.
 
 Because it's an autoload function, unlike the normal load system, it's loaded

doc/AutoPairsTrouble.txt

@@ -224,34 +224,15 @@ otherwise
 
 See also: https://github.com/LunarWatcher/auto-pairs/issues/66
 
-Due to the way Vim's input system works, if you map `<CR>` to configure
-auto-complete insertions, you can and will see auto-pairs act weirdly if
-|g:AutoPairsMapCR| is set.
-
-There's a large number of auto-complete plugins, and a large number of
-different systems. Several modern auto-complete plugins are additionally
-async, which adds a layer of complexity.
-
-The execution order of auto-pairs and auto-complete plugins, though
-particularly coc.nvim has been demonstrated to do this, isn't deterministic.
-coc's timeout may or may not fire in time for auto-pairs to have completed,
-and if it fires before auto-pairs has a chance to do anything, `pumvisible()`
-or similar isn't viable.
-
-Simply put, the pum may have closed by the time auto-pairs is executed. Simply
-put, there's no easy way to fix this behavior.
-
-Workarounds~
-
-The first option is disabling |g:AutoPairsMapCR|, and changing your map to
-incorporate `\<cr>\<C-r>=autopairs#Keybinds#IgnoreInsertEnter('autopairs#AutoPairsReturn')\<cr>`
-into your mapping. Auto-pairs simply wasn't meant for this type of use, so
-yes, the command is nasty. This has to be as the fallback to the pum being
-visible for a custom `<CR>` map. This is left as an exercise to the reader.
-
-Alternative B... stop using `<CR>` to insert the completion match, and get
-used to <C-y>, which is a default Vim mapping for completion insertion. Or, of
-course, map completion insertion to an altogether different key.
+There's no known reason why auto-pairs misbehaves when <CR> is remapped to
+allow for `<CR>` to pick an autocomplete option. See the linked issue
+for debug instructions that would help me narrow this down if you're currently
+running into this issue.
+
+Note that there previously was an incorrect explanation for the error both
+in this section of the help document, and the issue. That explanation was
+based on a blatant misunderstanding. See also |autopairs-bad-cr| for a general
+problem description, as well as roughly the same troubleshooting steps
 
 ==============================================================================
 7. Test failures (and related errors)                  *autopairs-test-failures*

doc/PluginCompatibility.txt

@@ -37,7 +37,7 @@ vague, the implementation details are unclear and therefore not implemented.
 
 That being said, due to the use of keybinds that do conflict with the plugin,
 such as |<cr>| and potentially others, depending on various mapping details,
-VM may produce warnings. It's adviced that you suppress these, as they're
+VM may produce warnings. It's advised that you suppress these, as they're
 unavoidable at the time of writing. The warnings may be suppressed with: >
     let g:VM_show_warnings = 0
 <