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

lang handin-server/checker - improve docs for first timers #34

Open
maueroats opened this issue May 26, 2019 · 0 comments
Open

lang handin-server/checker - improve docs for first timers #34

maueroats opened this issue May 26, 2019 · 0 comments

Comments

@maueroats
Copy link

maueroats commented May 26, 2019

Summary

The header line of the documentation for the Handin Server makes it sounds like there is a #lang handin-server/checkin. Installing the module makes no such header line permissible.

If the intention is that such a language line work, then fix and include it in an example. Otherwise edit documentation to make it clear how to use the module (example below).

Suggested improvements in documentation

Add a line to the first example in Section 6.3 Checker that shows #lang racket or
; intermediate student language if that is appropriate (I can't figure it out).

Edit example so that it actually works - remove ellipsis and put the appropriate provide (and require?) statements so that it exports something called checker. To offer something concrete:

#lang racket
(module the-checker ...   ; rest as written in docs
    (provide checker))
(require (submod "." the-checker))
(provide checker)

Steps to reproduce

#lang handin-server/checker

Expected result

Empty program runs or gives error that the user has not written a checker: form.

Actual Result:

Error - language is not found.

standard-module-name-resolver: collection not found
  for module path: handin-server/checker/lang/reader
  collection: "handin-server/checker/lang"
  in collection directories: [...]
@maueroats maueroats changed the title lang handin-server/checker misleading title lang handin-server/checker - improve docs for first timers May 26, 2019
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