Skip to content

Commit

Permalink
add new known problem: trailing dot/space in jsdoc
Browse files Browse the repository at this point in the history
closes #11
  • Loading branch information
phil294 committed Apr 26, 2022
1 parent bdf0780 commit 63580bd
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 63580bd

Please sign in to comment.