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

Add link to symbols page from any relevant :doc output #389

Open
byorgey opened this issue May 29, 2024 · 0 comments
Open

Add link to symbols page from any relevant :doc output #389

byorgey opened this issue May 29, 2024 · 0 comments
Labels
C-Low Hanging Fruit Shouldn't take too much time; ideal issues for new contributors. Z-Documentation Z-Student Good project for a student.

Comments

@byorgey
Copy link
Member

byorgey commented May 29, 2024

The Disco reference documentation has this page:

https://disco-lang.readthedocs.io/en/latest/reference/symbols.html

which can be helpful but is hard to find unless you know it's there. We should add a link to this page to the output of the :doc command for anything relevant. For example, something like this:

Disco> :doc /\
~/\~ : Bool × Bool → Bool
Alternative syntax: ~and~, ~∧~, ~&&~
precedence level 4, right associative

Logical conjunction (and): true /\ true = true; otherwise x /\ y = false.

https://disco-lang.readthedocs.io/en/latest/reference/logic-ops.html
https://disco-lang.readthedocs.io/en/latest/reference/symbols.html
@byorgey byorgey added C-Low Hanging Fruit Shouldn't take too much time; ideal issues for new contributors. Z-Documentation labels May 29, 2024
@byorgey byorgey added the Z-Student Good project for a student. label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Low Hanging Fruit Shouldn't take too much time; ideal issues for new contributors. Z-Documentation Z-Student Good project for a student.
Projects
None yet
Development

No branches or pull requests

1 participant