Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation enhancements #648

Closed
Roba1993 opened this issue Oct 11, 2023 · 1 comment
Closed

Documentation enhancements #648

Roba1993 opened this issue Oct 11, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@Roba1993
Copy link
Contributor

Roba1993 commented Oct 11, 2023 •
edited
Loading

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
@udoprog udoprog added the enhancement New feature or request label Oct 11, 2023
@Roba1993 Roba1993 changed the title Documentation lacks module overview Documentation enhancements Oct 30, 2023
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Ordering of the modules by their name ref rune-rs#648
ccc8058
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Better doc ordering of modules rune-rs#648
6e8b6dd
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Docs link back to root overview ref rune-rs#648
6cc948f
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Remove warnings ref rune-rs#648
861504e
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Docs prevent double modules with no documentation ref rune-rs#648
aeb3aa0
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Doc better field getter & setter ref rune-rs#648
e03b56e
Roba1993 added a commit to Roba1993/rune that referenced this issue Mar 13, 2024
@Roba1993
Also field functions can be deprecated ref rune-rs#648
3ae8acd
@Roba1993 Roba1993 mentioned this issue Mar 13, 2024
Merged
@udoprog
Copy link
Collaborator

udoprog commented Mar 13, 2024

Closed in #677, cheers!

@udoprog udoprog closed this as completed Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@udoprog @Roba1993