idris-lang/Idris2
1
1
Fork 0
mirror of https://github.com/idris-lang/Idris2.git synced 2024-11-23 22:22:07 +03:00
Code Issues Projects Releases Wiki Activity

Appease the linter

Browse Source 
Hey I haven't even touched those things!
This commit is contained in:
Vit Brunner 2022-03-14 18:13:55 +01:00
parent f16b5d63d2
commit b1040a26b3
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -31,7 +31,7 @@ general philosophy of the Idris project, which can be summarised as follows:
properties of programs, but will not *require* them to do so properties of programs, but will not *require* them to do so
Many contributions will require acccompanying tests and documentation updates. Many contributions will require acccompanying tests and documentation updates.
Bug fixes in particular should be accompanied by tests, to avoid future Bugfixes in particular should be accompanied by tests, to avoid future
regressions. regressions.
Library functions should be `total` as far as possible, and at least `covering` Library functions should be `total` as far as possible, and at least `covering`
@ -116,7 +116,7 @@ Things we probably won't accept
We encourage following the camp site rule: leave the code tidier than you We encourage following the camp site rule: leave the code tidier than you
found it! found it!
* Primitive updates without a strong justification * Primitive updates without a strong justification
- Primitives increase the burden on back end authors, for example. They may - Primitives increase the burden on backend authors, for example. They may
be necessary to support a new library, if a foreign function call is not be necessary to support a new library, if a foreign function call is not
appropriate, but we won't accept a primitive on the basis that it could be appropriate, but we won't accept a primitive on the basis that it could be
useful in future. useful in future.
@ -128,9 +128,9 @@ Things we probably won't accept
Idris 2 API, to minimise the maintenance burden on the compiler. Idris 2 API, to minimise the maintenance burden on the compiler.
* Similarly, anything which adds an external dependency. We aim to keep * Similarly, anything which adds an external dependency. We aim to keep
dependencies minimal for ease of initial installation. dependencies minimal for ease of initial installation.
* New back ends. You can implement new back ends via the Idris 2 API - and indeed * New backends. You can implement new backends via the Idris 2 API - and indeed
several people have. The back ends in this repository are limited to those several people have. The backends in this repository are limited to those we
we are able to commit to maintaining. are able to commit to maintaining.
Other possible contributions Other possible contributions
---------------------------- ----------------------------

14
README.md
View File

@ -18,9 +18,9 @@ is often one of `scheme`, `chezscheme` or `chezscheme9.5` (depending on the
version). On a modern desktop machine, this process (including tests) version). On a modern desktop machine, this process (including tests)
should take less than 5 minutes. should take less than 5 minutes.
Idris 2 is mostly backwards compatible with Idris 1, with some minor Idris 2 is mostly backward compatible with Idris 1, with some minor exceptions.
exceptions. The most notable user visible differences, which might cause Idris The most notable user visible differences, which might cause Idris 1 programs
1 programs to fail to type check, are: to fail to type check, are:
+ Unbound implicit arguments are always erased, so it is a type error to + Unbound implicit arguments are always erased, so it is a type error to
attempt to pattern match on one. attempt to pattern match on one.
@ -70,8 +70,8 @@ Summary of new features:
declarations. declarations.
+ Better type checker implementation which minimises the need for compile + Better type checker implementation which minimises the need for compile
time evaluation. time evaluation.
+ New Chez Scheme based back end which both compiles and runs faster than the + New Chez Scheme based backend which both compiles and runs faster than the
default Idris 1 back end. (Also, optionally, Racket and Gambit can be used default Idris 1 backend. (Also, optionally, Racket and Gambit can be used
as targets). as targets).
+ Everything works faster :). + Everything works faster :).
@ -80,9 +80,9 @@ language `TTImp`, which is essentially a desugared Idris, and is cleanly
separated from the high level language which means it is potentially usable separated from the high level language which means it is potentially usable
as a core language for other high level syntaxes. as a core language for other high level syntaxes.
Javascript JavaScript
---------- ----------
The javascript codegen uses the new BigInt, hence nodejs 10.4 or higher is required. The JavaScript codegen uses the new BigInt, hence Node.js 10.4 or higher is required.
Editor Plugins Editor Plugins
-------------- --------------