Skip to content

Commit 538ae40

Browse files
committed
Update readmes (#10)
1 parent 9836c21 commit 538ae40

3 files changed

Lines changed: 6 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ In general, it uses `--check` instructs `simfmt` to exit with an error code if t
9898

9999
### Running `simfmt` from your editor
100100

101-
* [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl)
101+
* [Visual Studio Code][2]
102102

103103
### Configuring `simfmt`
104104

@@ -131,4 +131,5 @@ Simfmt is distributed under the terms of both the MIT license.
131131
See [MIT license](LICENSE) for details.
132132

133133

134-
[1]: https://simplicity-lang.org/
134+
[1]: https://simplicity-lang.org/
135+
[2]: [https://simplicity-lang.org/](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl)

‎crates/cli/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ $ simfmt --emit files contract.simf
145145
## Editor integration
146146

147147
[SimplicityHL][1] formatting is available through the
148-
[Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl).
148+
[Visual Studio Code extension][3].
149149

150150
## Limitations
151151

@@ -170,4 +170,5 @@ See the repository's [contribution guide](../../Contributing.md) and
170170
`simfmt` is distributed under the [MIT License](../../LICENSE).
171171

172172
[1]: https://simplicity-lang.org/
173-
[2]: [https://simplicity-lang.org/](https://github.com/BlockstreamResearch/simfmt/blob/master/.github/scripts/simfmt-check)
173+
[2]: [https://simplicity-lang.org/](https://github.com/BlockstreamResearch/simfmt/blob/master/.github/scripts/simfmt-check)
174+
[3]: https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl

‎crates/prettysimf/README.md‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,6 @@ users:
3434
* line width;
3535
* newline style.
3636

37-
## Errors
38-
39-
`pretty_simf_please` returns one of three `PrettySimfError` variants:
40-
41-
* `Operational` means the formatter could not complete an operational step.
42-
* `FormatError` means the input could not be parsed or formatted safely; its
43-
message contains the formatter diagnostics.
44-
* `StringConversion` means the formatted output unexpectedly contained invalid
45-
UTF-8.
46-
4737
The in-memory API has the same [formatter limitations][2] as the `simfmt` CLI.
4838

4939
## Driver API

0 commit comments

Comments
 (0)