rune-rs/rune

Documentation enhancements

Roba1993 opened this issue · 1 comments

A list of all documentation enhancements/problems I noticed.

  • The new generated rune documentation lacks a link to the module overview.
    • So when I'm at this location there is no link to this page.
  • Too long source code is overflowing on the right side
    • Bildschirmfoto 2023-10-30 um 09 38 20
  • When defining a module twice it's shown two times
    • e.g. When using io-nocapture and implement own dbg/print/println functions
    • Both links show the same content, but in this case the link with no comment should be hidden IMHO
    • Bildschirmfoto 2023-10-30 um 09 41 06
  • The ordering of the modules is random
    • Bildschirmfoto 2023-10-30 um 09 42 18
  • The display of protocol functions is not intuitive
    • Get / Set should have the field in the header to make it easier to read
      • Bildschirmfoto 2023-10-30 um 09 44 56
  • Field functions can be deprecated, when manually defined

Closed in #677, cheers!