-
Notifications
You must be signed in to change notification settings - Fork 152
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
Adding documentation for generics #672
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is awesome, thank you! I have made some observations -- hopefully they're not too nitpicky.
Yes, I think we can remove the "experimental" warning. Do you want to include a commit to do that? Thank you!
doc/BH_ref_guide/BH_lang.tex
Outdated
{\alt} \term{�} | ||
{\alt} \term{�} | ||
{\alt} $\term{�}$ | ||
\term{�} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, this something that maybe @mieszko should have a look at. I believe this is describing the characters that are allowed as "symbols" for creating operators, and that may have changed when he updated BSC to expect Unicode encoding for source files.
e66ec61
to
264633b
Compare
I think I addressed all the comments. Also removed the experimental warning. |
260ed93
to
6e0b189
Compare
Looking at the places I may also try to squash some of your commits together, to clean up the history. I would prefer not to merge this PR as one squashed commit, because some of the individual commits are useful, but I would prefer not to have little fixup commits at the end or change and then revert commits. |
6e0b189
to
e1aa0fd
Compare
Ok, I've force-pushed new commits, that clean up the history and include a fix for the macros. If it looks good to you, I'll merge it. Thanks! |
Looks good! |
e1aa0fd
to
761a2e8
Compare
The directive |
761a2e8
to
83b71de
Compare
This adds documentation for the generics feature of B-lang. I made an inital effort in doing this using BSV for consistency with the rest of the library reference guide, but gave up and decided to write this up using BH for now.
Also, make a small tweak to
CShow
to print out a filler string for higher-rank fields, rather than giving a somewhat cryptic error message aboutCShow'
not having an instance forConcPoly
.I am also wondering if we should remove the warning about generics being an unstable feature, at this point, as I don't really expect the interface to change going forward?