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

Improve docstrings #100

Open
samestep opened this issue Sep 18, 2023 · 0 comments
Open

Improve docstrings #100

samestep opened this issue Sep 18, 2023 · 0 comments

Comments

@samestep
Copy link
Contributor

Currently if you hover over Real in this example in VS Code:

import { Real } from "rose";

The following docstring appears:

An abstract 64-bit floating point number. The 64-bit floating-point type.

This is the concatenation of the docstrings for the static and dynamic meanings of Real:

/** An abstract 64-bit floating point number. */
export type Real = number | Var;

/** The 64-bit floating-point type. */
export const Real = Symbol("Real");

We should fix this so that the concatenated docstring makes more sense.

Also, many of the docstrings are too terse or simply wrong; for instance, the interp docstring says it only works on "nullary" functions, which is incorrect as of #80:

/** Concretize the nullary abstract function `f` using the interpreter. */
export const interp =

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant