MFlowCode / MFC

Exascale simulation of multiphase/physics fluid dynamics
https://mflowcode.github.io
MIT License
132 stars 58 forks source link

Documentation typos #508

Closed ChrisZYJ closed 1 week ago

ChrisZYJ commented 1 week ago

Description

All %'s are missing on the Case Files page. Fixed by replacing % within literal backtick expressions by %%. Also fixed some other typos / formatting.

Type of change

Scope

sbryngelson commented 1 week ago

Thanks @ChrisZYJ! It took me way to long to figure this out, but the solution is to use two percent signs to get one real one. x%%y in a literal backtick expression = x%y on the website

ChrisZYJ commented 1 week ago

Thanks! I would never have thought of that on my own

sbryngelson commented 1 week ago

Thanks! I would never have thought of that on my own

Me either! Some careful Googling found the trick for me. You can build the documentation on your local machine via ./mfc.sh build -t documentation to try many different things or just check things are working as expected.

ChrisZYJ commented 1 week ago

Thanks for the tips on how to build the pages locally - that makes debugging much easier.

Just found a few more issues: while a%%b -> a%b works, a%%b[x] -> a%%b[x] introduces an extra % instead. Same for a%% -> a%%. Fixing that now