diff --git a/README.md b/README.md index b588499..b687c35 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ In general, it uses `--check` instructs `simfmt` to exit with an error code if t ### Running `simfmt` from your editor -* [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl) +* [Visual Studio Code][2] ### Configuring `simfmt` @@ -131,4 +131,5 @@ Simfmt is distributed under the terms of both the MIT license. See [MIT license](LICENSE) for details. -[1]: https://simplicity-lang.org/ \ No newline at end of file +[1]: https://simplicity-lang.org/ +[2]: [https://simplicity-lang.org/](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl) \ No newline at end of file diff --git a/crates/cli/README.md b/crates/cli/README.md index 02bb81e..166c91a 100644 --- a/crates/cli/README.md +++ b/crates/cli/README.md @@ -145,7 +145,7 @@ $ simfmt --emit files contract.simf ## Editor integration [SimplicityHL][1] formatting is available through the -[Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl). +[Visual Studio Code extension][3]. ## Limitations @@ -170,4 +170,5 @@ See the repository's [contribution guide](../../Contributing.md) and `simfmt` is distributed under the [MIT License](../../LICENSE). [1]: https://simplicity-lang.org/ -[2]: [https://simplicity-lang.org/](https://github.com/BlockstreamResearch/simfmt/blob/master/.github/scripts/simfmt-check) \ No newline at end of file +[2]: [https://simplicity-lang.org/](https://github.com/BlockstreamResearch/simfmt/blob/master/.github/scripts/simfmt-check) +[3]: https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl \ No newline at end of file diff --git a/crates/prettysimf/README.md b/crates/prettysimf/README.md index 3930cd5..150ec20 100644 --- a/crates/prettysimf/README.md +++ b/crates/prettysimf/README.md @@ -34,18 +34,6 @@ users: * line width; * newline style. -## Errors - -`pretty_simf_please` returns one of three `PrettySimfError` variants: - -* `Operational` means the formatter could not complete an operational step. -* `FormatError` means the input could not be parsed or formatted safely; its - message contains the formatter diagnostics. -* `StringConversion` means the formatted output unexpectedly contained invalid - UTF-8. - -The in-memory API has the same [formatter limitations][2] as the `simfmt` CLI. - ## Driver API The `prettysimf::driver` module exposes the shared configuration types, runtime