source-academy / js-slang

Implementations of sublanguages of JavaScript, TypeScript, Scheme and Python
https://source-academy.github.io/source/
Apache License 2.0
64 stars 102 forks source link

fixing unicode errors in build: more fixes needed #1701

Closed martin-henz closed 1 month ago

coveralls commented 2 months ago

Pull Request Test Coverage Report for Build 8966713762

Details


Totals Coverage Status
Change from base Build 8938442915: 0.0%
Covered Lines: 10930
Relevant Lines: 12966

💛 - Coveralls
martin-henz commented 2 months ago

We seem to be missing the leading backslashes of \Theta and \Omega.

Can we also add a check to the CI workflow?

We seem to be missing the leading backslashes of \Theta and \Omega.

Can we also add a check to the CI workflow?

The backslashes wouldn't lead to a good output. We could escape these things by saying ^$\Theta$^ to get a nice PDF.

But then the json output for autocomplete would look really ugly (unless we do some more magic). Also jsdoc would look bad.

So at the moment, docs/lib/list.js is used for:

and we just tolerate a "Theta" appearing everywhere, to keep things simple.

RichDom2185 commented 2 months ago

We seem to be missing the leading backslashes of \Theta and \Omega.

Can we also add a check to the CI workflow?

Hi Prof @martin-henz, I've fixed these, though I can't check as I don't have LaTeX installed locally. Could you verify that it's correct now?

Edit: Didn't see the above comment

RichDom2185 commented 2 months ago

So at the moment, docs/lib/list.js is used for:

  • PDF
  • jsdocs
  • autocomplete

and we just tolerate a "Theta" appearing everywhere, to keep things simple.

Replacing Θ with &#1012 works nicely in JSDoc. How about the others?

martin-henz commented 1 month ago

So at the moment, docs/lib/list.js is used for:

  • PDF
  • jsdocs
  • autocomplete

and we just tolerate a "Theta" appearing everywhere, to keep things simple.

Replacing Θ with &#1012 works nicely in JSDoc. How about the others?

The file list.js is currently attached verbatim (using lstlisting in LaTeX) to source_2.pdf.

That means it will look ugly (illegible).

On the longer run, we should find a way to attach list.js in a nicer way to source_2.pdf.

I suggest we go ahead with just "Theta" (and make an issue) for now.

RichDom2185 commented 1 month ago

I suggest we go ahead with just "Theta" (and make an issue) for now.

Made the issue in #1705