1
1
mirror of https://github.com/google/ormolu.git synced 2024-08-16 03:20:30 +03:00
Commit Graph

28 Commits

Author SHA1 Message Date
Facundo Domínguez
5bffeffa05 Update design notes for CPP. 2020-04-24 23:08:37 +02:00
mrkkrp
096c8d7f63 Update the readme
Also adds the note to ‘DESIGN.md’ stating that it's no longer being updated.
2019-10-04 11:44:21 +02:00
mrkkrp
8466d6e743 Change the style of type signatures
The commit changes how type signatures are printed. The new style looks like
this:

  foo ::
    Int ->
    Char ->
    String

This works better with foralls and other features of the type system that
will be added in the near future, like linear arrows.

In order to print Haddocks nicely (this seems to be the only acceptable
placement):

  foo ::
    -- | First argument
    Int ->
    -- | Second argument
    Char ->
    -- | Result
    String

It is often necessary to re-arrange them completely and use the “pipe style”
instead of “caret style”. It proved to be a very hard task with our older
comment-handling system, if not impossible.

Here we start parsing Haddocks so that they are treated as components of AST
and we now render them as part of rendering of those components. The
existing framework for handling comments only prints non-Haddock comments
now.

The change caused a fair number of new problems and failures which I added
new tests for.
2019-10-02 16:52:42 +02:00
mrkkrp
19deae563b
Add examples to table of contents and drop the roadmap
[skip ci]
2019-08-21 12:31:02 +02:00
B YI
6408a34e45 Correct the dead link to examples in ‘DESIGN.md’ 2019-08-21 12:30:01 +02:00
mrkkrp
f1d07ca9ce Minor corrections to the design document 2019-02-14 22:12:13 +01:00
Facundo Domínguez
66b22d7d03 Support no configuration. 2019-01-10 14:20:05 -03:00
Facundo Domínguez
410d2ec4bb Update section on Hindent. (#13) 2019-01-05 18:26:37 +07:00
Facundo Domínguez
ef1c8d3262 Update analysis for contributions. (#14) 2019-01-05 18:25:50 +07:00
Facundo Domínguez
fd1c88112b Style edits. 2019-01-04 12:32:43 -03:00
Facundo Domínguez
d9171cc7b9 Style edits. 2019-01-04 10:42:23 -03:00
Facundo Domínguez
b4bb9a4f1a Tighten Brittany's section. 2019-01-04 10:32:35 -03:00
mrkkrp
304671e86b
Incorporate Mathieu's design 2019-01-03 23:02:04 +07:00
Mark Karpov
cfc8dbf328
Improve analysis of existing solutions (#10) 2019-01-03 23:00:56 +07:00
Facundo Domínguez
690d7e88ed
Simplify the failing CPP example 2018-12-20 08:44:19 -03:00
Facundo Domínguez
f0aea980b3 Add formatting examples for discussion. 2018-12-18 11:32:46 -03:00
Facundo Domínguez
84cf555707 Explain more of the rationale for excluding CPP. (#7)
* Explain more of the rationale for excluding CPP.

* Change the CPP example to change the meaning. Use hindent.

* Fix a typo
2018-12-15 20:25:26 +07:00
Mark Karpov
6ea0b524ab
Merge pull request #8 from tweag/fd/goals
Set some goals.
2018-12-15 20:18:22 +07:00
Facundo Domínguez
ec58113c30 Set some goals. 2018-12-14 18:13:58 -03:00
Mark Karpov
a065f54bce
Merge pull request #5 from tweag/fd/self-check-design
Mention the self-check in the DESIGN
2018-12-12 12:46:50 +07:00
Facundo Domínguez
b9b9fc4113 Fix grammar and minor edits in CPP section. 2018-12-11 18:04:17 -03:00
Facundo Domínguez
8da9c0b803 Mention the self-check and edit testing section. 2018-12-11 17:58:20 -03:00
Facundo Domínguez
bf027f0d13
Edit opening of the CPP section in the DESIGN document 2018-12-11 13:52:36 -03:00
mrkkrp
bc2b919792
A couple more sentences about Brittany 2018-12-10 23:00:04 +07:00
mrkkrp
b5e26f8b6f
Mention ‘Outputable’ and ‘SDoc’ in the section about pretty printing
[skip ci]
2018-12-08 18:13:13 +07:00
mrkkrp
d94e08e0a2
Fix a link in the design document
[skip ci]
2018-12-08 14:45:21 +07:00
mrkkrp
386a933037
Update the design document
* Explain why forking or contributing to either Brittany or Hindent is not a
  good idea.
* Drop support for CPP from the design document, add Facundo's example as
  motivation.
* Add comparing of ASTs to the description of testing procedure.
* Describe functionality of executable.
* Update the roadmap.
2018-12-08 14:37:49 +07:00
mrkkrp
dc6605107a
Initial commit 2018-11-25 20:51:22 +07:00