A better documentation - Githubissues

GiggleLiu / NiLang.jl

A differential eDSL that can run faster than light and go back to the past.

https://giggleliu.github.io/NiLang.jl/dev

Apache License 2.0

250 stars 16 forks source link

A better documentation #53

Open GiggleLiu opened 3 years ago

GiggleLiu commented 3 years ago

Performance tips

[ ] when does compiler optimize away ~@routine

Notations

[ ] how to input leftarrow.

others

[ ] integers are not differentiated.

johnnychen94 commented 3 years ago

I find that Documenter-generated page https://giggleliu.github.io/NiLang.jl/dev/ is missing in README. Is the documentation plan to remove docs/ in favor of notebooks/?

johnnychen94 commented 3 years ago

I also noticed that @invcheckoff and @routine are not documented and it seems that they only live in the @i scope.

It's a little bit frustrating that neither NiLang.@invcheckoff nor ?NiLang.@invcheckoff return anything useful. The first time I use NiLang, I thought @invcheckoff is some kind of outdated usage because it's not defined in the NiLang scope.

GiggleLiu commented 3 years ago

@invcheckoff is in the performance tips...