search

aardappel / lobster

The Lobster Programming Language
http://strlen.com/lobster
2.21k stars 117 forks source link

Fixed some trivial typos (of ellipses). #306

Closed WraithGlade closed 4 months ago

WraithGlade commented 4 months ago

Hello! I really love the design of your language so far and am looking forward to using it! 😎

Anyway, I found some minor typos and fixed them in the doc codebase.

I ran the HTML regeneration batch script too after the typo fixes.

Should we do that for documentation fixes like this or should we not push the results of the regeneration scripts to the main repo? ⚠

I'm inclined to think you probably want it included, since that results in a more complete and consistent state.

Thank you for your time and efforts on this project and for reading my commit suggestion! 😁

aardappel commented 4 months ago

Thanks! Yes, html changes should also be pushed, but in your case a lot of the changes in the diff are caused by having a different version of pandoc installed.. try installing the latest, then running again.

WraithGlade commented 4 months ago

Ah, thanks for the info! I had forgotten that I haven't updated Pandoc a while.

I updated and redid the generation.

Is the new version good?

aardappel commented 4 months ago

Ok, this looks better, but there are now cases where it replaces a .. by a triple-dot single non-ascii character, I don't think thats an improvement.

WraithGlade commented 4 months ago

Thanks for the helpful feedback again Mr. Oortmerssen! 🙂

I wasn't aware of what kinds of things you do/don't want in the docs and so this is good info to know.

It makes sense to avoid special unicode characters in order to prevent unexpected problems when programmers copy-paste things.

As such, I changed the Pandoc command to no longer perform any such special character conversions in the resulting HTML output.

However, consequentially a huge number of lines are now changed (almost all having to do with special variants of quotation marks and spaces), but by doing so many hidden special characters have now been removed, thus also removing some subtle copy-paste hazards for programmers.

It does seem to slightly change the appearance of the HTML though.

I am not sure if it will be within your preferences, but I think so considering it is a technical/functional win (removes a hazard).

I found the info about how to fix this on this Pandoc GitHub page.

aardappel commented 4 months ago

I guess this -smart option is an improvent. Only thing to do is to also add it to the .sh script.

aardappel commented 4 months ago

Thanks :)

WraithGlade commented 4 months ago

Thanks for accepting my pull request!

I tried looking if there was a way to only prevent the "..."s from getting converted but a quick internet search didn't turn anything up. Perhaps it is possible somehow though. I'm not that familiar with Pandoc. It seems like perhaps it doesn't offer that level of fine-grained control though.