Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

In-language documentation #15

Closed
jkarni opened this issue Jun 2, 2018 · 1 comment
Closed

In-language documentation #15

jkarni opened this issue Jun 2, 2018 · 1 comment
Assignees
Labels
documentation enhancement New feature or request
Projects
Milestone

Comments

@jkarni
Copy link
Contributor

jkarni commented Jun 2, 2018

  • There should be a doc function which, given an identifier, returns the documentation for that identifier (if it exists).
  • There should be a way of documenting new functions that integrates with that doc function.
  • Existing primops should be documented.

I initially imagined there was good reason to have doc work only in the impure environment (since we want to maintain referential transparency). But I now realize doc can work on quoted identifiers and maintain referential transparency. (Note that quote is not a function, and in typed settings at least for subtle and profound reasons that I only half-remember, so there's no function from an unquoted value to it's documentation.)

@jkarni jkarni added the enhancement New feature or request label Jun 2, 2018
@jkarni jkarni self-assigned this Aug 27, 2018
@jkarni jkarni added this to the BCW milestone Aug 27, 2018
@jkarni jkarni mentioned this issue Sep 10, 2018
Merged
@jameshaydon jameshaydon added this to To do in Q4 2018 Oct 18, 2018
@jameshaydon jameshaydon assigned jameshaydon and unassigned jkarni Oct 18, 2018
@jameshaydon jameshaydon moved this from To do to In progress in Q4 2018 Oct 31, 2018
@jameshaydon jameshaydon moved this from In progress to Done in Q4 2018 Oct 31, 2018
@jameshaydon
Copy link
Contributor

Fixed in #177.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation enhancement New feature or request
Projects
No open projects
Q4 2018
  
Done
Development

No branches or pull requests

2 participants