search

erg-lang / erg

A statically typed language compatible with Python
http://erg-lang.org
Apache License 2.0
2.63k stars 54 forks source link

Add doc comments for built-in APIs #351

Open mtshiba opened 1 year ago

mtshiba commented 1 year ago

I have added doc comments feature to Erg. This allows me to view the API documentation on hover from the editor.

doc-comments

So, I would like to add documentation for the Python-derived API. The main body of documentation can be found here.

https://github.com/erg-lang/erg/blob/5f29814fa854d1f09e429d4dfe40126bf71ef580/compiler/erg_compiler/lib/pystd/builtins.d.er#L1-L28

The documentation is formatted in Markdown from the output of Python's help function.

mtshiba commented 1 year ago

cf. https://github.com/erg-lang/erg/blob/main/doc/EN/syntax/00_basic.md#documentation-comments