~sschwarzer/racket-glossary

Explanations of Scheme and Racket concepts
Add note on profiling
Unify formatting of cross-references
Make "Provide" and "Require" cross-references to "Module"

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~sschwarzer/racket-glossary
read/write
git@git.sr.ht:~sschwarzer/racket-glossary

You can also use your local clone with git send-email.

#Racket Glossary

This project intends to help primarily Racket beginners and intermediate users understand Racket concepts and interactions between them.

#Purpose

  • Give definitions of terms used in Racket and Scheme in general.

  • Help beginning and intermediate users understand terms encountered in the Racket documentation. Assume that readers are familiar with imperative programming, but not with functional programming, Scheme and Racket. Therefore, some entries may contain comparisons with related features in other programming languages.

  • Provide context. Most entries have more content than you'd usually expect from a glossary.

#Preview

You can see the current state of the glossary on the Racket package server.

At the moment, the completion state (generated with the glossary-stats.rkt script) is:

Completion stats, ignoring cross references:

basic        |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■·············|  41 of  55  (75 %)  done
intermediate |■■■■■■■···········································|   5 of  34  (15 %)  done
advanced     |··················································|   0 of  25  ( 0 %)  done

total        |■■■■■■■■■■■■■■■■■■■■······························|  46 of 114  (40 %)  done

#Contributions

I'll surely need some feedback, especially on the intermediate and advanced entries. There are several contribution channels:

If you want to send commits, you can:

  • Send diffs (for example, created with git diff) to the mailing list (see above).

  • Send a URL for a public repository of yours to the mailing list (see above). I'll pull from there and contact you with feedback, if necessary.

  • Enter a pull request on Github.

I recommend that you, at least for now, make contributions to the glossary-notes.md file. See the beginning of that file for information on what to add there.

Although not strictly necessary, I'd appreciate it if you wrote commit messages according to these rules.

#License

See the file LICENSE.

Do not follow this link