From 63580bd7bd929a11eecda07c6e49c2f736aa92d8 Mon Sep 17 00:00:00 2001 From: phil294 Date: Tue, 26 Apr 2022 18:14:52 +0200 Subject: [PATCH] add new known problem: trailing dot/space in jsdoc closes #11 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 94ca54f2..9e743609 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,8 @@ There is lot of hacky code to get this all to work. One thing to keep in mind is - General: - Make sure you never leave any dangling indentation in your source code around, unless it's the line you are working on. In VSCode, this is the default - just make sure to **not** override `"editor.trimAutoWhitespace"` to `false`. Keep it at its default `true`. Same thing goes for other IDEs: Try not to have more than one empty line with indentation. This is because CoffeeSense treats any line with indent as a possible place for you to define new object properties or arguments, as it is not aware of the cursor position while compiling. It injects certain characters at these lines which gets messy if you're on another line. - Trailing whitespace is disallowed because it takes on special meaning while autocompleting +- Cosmetics: + - JSDoc lines with trailing space or dot can look funny in tooltips if you don't start the line with a number sign ([issue](https://github.com/phil294/coffeesense/issues/11)). Also, implicit any errors (7006) for variables named `_` are ignored.