Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Docs. #131

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

| command screenshot | command name |
|---|---|
| [Typecheck the currently open file](https://github.com/zjhmale/vscode-idris/blob/master/FEATURES.md#typechecking) | idris.typecheck |
| [Type check the currently open file](https://github.com/zjhmale/vscode-idris/blob/master/FEATURES.md#typechecking) | idris.typecheck |
| [Print the type of the identifier under the cursor](https://github.com/zjhmale/vscode-idris/blob/master/FEATURES.md#showing-the-type-of-an-identifier) | idris.type-of |
| [Print the documentation of the identifier under the cursor](https://github.com/zjhmale/vscode-idris/blob/master/FEATURES.md#showing-the-docs-for-an-identifier) | idris.docs-for |
| [Print the definition of the identifier under the cursor](https://github.com/zjhmale/vscode-idris/blob/master/FEATURES.md#showing-the-definition-for-an-identifier) | idris.print-definition |
Expand Down Expand Up @@ -71,12 +71,12 @@ The following Visual Studio Code settings along with their *default* values that
"idris.hoverMode": "fallback", // Controls the hover behavior. 'info' will display Idris documentation, 'type' will display Idris type, 'fallback' will try 'info' first and fallback to 'type' if we can not get the documentation, and 'none' will disable hover tooltips.
"idris.suggestMode": "allWords" // Controls the auto-completion behavior. 'allWords' will always include all words from the currently opened documentation, 'replCompletion' will get suggestions from Idris REPL process.
"idris.warnPartial": false // Show warning when a function is partial.
"idris.showOutputWhenTypechecking": false //Show output channel when typechecking finished.
"idris.numbersOfContinuousTypechecking": 10 //Kill Idris process every N times of continuous typechecking to avoid memory leaking.
"idris.showOutputWhenTypechecking": false //Show output channel when type checking finished.
"idris.numbersOfContinuousTypechecking": 10 //Kill Idris process every "n" times of continuous type checking to avoid memory leaking.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"n" can be 'n' is even better I think.

}
```

## Acknowledgements
## Acknowledgement

* The internal design is initially inspired by [atom-language-idris](https://github.com/idris-hackers/atom-language-idris).

Expand Down