Originally noticed by @CryptoPascal31, there are several incorrect examples and descriptions in the natives docs. These are a couple of them. Namely:
describe-table was a copy-paste of describe-module and incorrectly listed the field names in the object it returns
the principal examples use 'k:12345 but the symbol syntax is incompatible with the use of a colon
For the latter, you can trivially verify the error with:
➜ nix run github:thomashoneyman/pact-nix#pact
pact> (is-principal 'k:12345)
(interactive):1:17: error: Expected: atom, Expected: list, Expected: literal, Unexpected end of input
pact> (is-principal "k:12345")
false
For maintainers: for documentation PRs in which I'm updating the Haskell code, should I be committing the updated .md files as well? Or just the Haskell? It's not clear to me what is generated in the release process.
PR checklist:
[ ] Test coverage for the proposed changes
[ ] PR description contains example output from repl interaction or a snippet from unit test output
[ ] Documentation has been updated if new natives or FV properties have been added. To generate new documentation, issue cabal run tests. If they pass locally, docs are generated.
Originally noticed by @CryptoPascal31, there are several incorrect examples and descriptions in the natives docs. These are a couple of them. Namely:
For the latter, you can trivially verify the error with:
For maintainers: for documentation PRs in which I'm updating the Haskell code, should I be committing the updated .md files as well? Or just the Haskell? It's not clear to me what is generated in the release process.
PR checklist:
cabal run tests. If they pass locally, docs are generated.pact -t), make sure pact-lsp is in sync.Additionally, please justify why you should or should not do the following: