lampepfl / dotty-feature-requests

Historical feature requests. Please create new feature requests at https://github.com/lampepfl/dotty/discussions/new?category=feature-requests
31 stars 2 forks source link

dotty online documentation is missing API documentation for dotty-interfaces #33

Open smarter opened 7 years ago

smarter commented 7 years ago

This is the only officially supported API, so it's kind of ironic that we don't display its documentation at all :). I think this points to an issue with the way dottydoc works currently: it mixes API docs with human-written documentation. Instead I think it would make sense if http://dotty.epfl.ch/docs/ did not directly contain any API documentation but instead had links to http://dotty.epfl.ch/docs/dotty-interfaces and http://dotty.epfl.ch/docs/dotty-compiler, etc.

Varunram commented 7 years ago

@smarter Is this a novice issue or one reserved for experts? Please do add a tag :) Thanks!

smarter commented 7 years ago

Not reserved for experts but not very simple either, we need to discuss what the best way to present the documentation is, and then implement it.

nicolasstucki commented 6 years ago

As mentioned in #4918 the dotty library docs are also missing.