search

dsa-ou / algoesup

Algorithmic essays support: examples, templates, guides, library
https://dsa-ou.github.io/algoesup/
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Linting reference shows functions, not magics #15

Closed mwermelinger closed 8 months ago

mwermelinger commented 8 months ago

@densnow wrote "I am starting to think having the docs auto generated for the magic commands (i.e having a function signature which is not supposed to be called) could be misleading. Would you agree?"

Yes, that part of the library reference needs to be written by hand, or just hide the signature for those functions.

densnow commented 8 months ago

Made a couple of commits to fix typos, change Dockerfile and roll back version of package that was causing me issues. At the same time the option to hide the signature of the magic functions has been added to library.md

I think it looks OK, so probably this issue can be closed.

mwermelinger commented 8 months ago

Closed by 83628d4ceccb126b14a0f693b5f7f02712bcd235