search

shop-planner / shop3

SHOP3 Git repository
https://shop-planner.github.io
144 stars 14 forks source link

Fixes from Kostas. #127

Closed rpgoldman closed 1 year ago

rpgoldman commented 1 year ago

Several documentation fixes.

I kept most of the ones from @ko56 , with the exception of some cases where @var was used for lisp variables. I checked the Texinfo manuals and it's quite clear that this is not for programming language variables; only for meta-variables.

I also found a place where "conjunct" and "disjunct" were used incorrectly in place of conjunction and disjunction -- this is probably a bug carried over from the original SHOP2 manual.

ko56 commented 1 year ago

Looks good. I wasn't aware of the subtle distinction between @var and @code. One typo I caught: on line 33, ASDF,, -> ASDF,. Also, I can't tell if you fixed anything in the file @include include/fun-shop-find-plans-stack.texinfo, that seems to have a problem, as I had indicated in a @comment.

rpgoldman commented 1 year ago

Also, I can't tell if you fixed anything in the file @include include/fun-shop-find-plans-stack.texinfo, that seems to have a problem, as I had indicated in a @comment.

That file is automatically generated from the SHOP code using the sb-texinfo library as a shop submodule. I have improved the formatting for this substantially, but really fixing it requires extending my fork of sb-texinfo. So I propose to call this "good enough" for now.

I need to figure out how to have a GitHub action format the manual to make review easier. I'm not entirely sure how to do this.