Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation missing on backtick import of types #1042

Closed
weaversa opened this issue Jan 20, 2021 · 2 comments
Closed

Documentation missing on backtick import of types #1042

weaversa opened this issue Jan 20, 2021 · 2 comments
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation parameterized modules Related to Cryptol's parameterized modules

Comments

@weaversa
Copy link
Collaborator

module parmodule where

parameter
        type k : #
        type constraint (fin k)

type ParObj = [k]
module parmoduleUser where

import `parmodule

type n = 8

type UserObj = ParObj n  // This is undocumented.

x : UserObj
x = 10

See: https://github.com/GaloisInc/cryptol/blob/master/docs/Syntax.md

The documentation there would lead one to believe the correct way to define this type is to do type UserObj = ParObj {k = n}.

@yav
Copy link
Member

yav commented Jan 21, 2021

The plan is to remove this feature, so I am not sure we should invest much effort in documenting it.

@robdockins robdockins added docs LaTeX, markdown, literate haskell, or in-REPL documentation parameterized modules Related to Cryptol's parameterized modules labels Feb 9, 2021
@yav
Copy link
Member

yav commented Feb 19, 2025

This feature was not removed, and is now documented here:
https://galoisinc.github.io/cryptol/master/Modules.html#instantiation-by-parametrizing-declarations

@yav yav closed this as completed Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation parameterized modules Related to Cryptol's parameterized modules
Projects
None yet
Development

No branches or pull requests

3 participants