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

[Merged by Bors] - Doc/module style doc blocks for examples #4438

Closed
wants to merge 23 commits into from
Closed

[Merged by Bors] - Doc/module style doc blocks for examples #4438

wants to merge 23 commits into from

Commits on May 15, 2022

  1. Add a module doc block to the 2d/contributors example. 

    The comment aims to explain what the example shows and to give an overview on how it works.
    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    ab2b895 View commit details
    Browse the repository at this point in the history

  2. Add a module doc block to the 2d/many_sprites benchmark example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    9f6925d View commit details
    Browse the repository at this point in the history

  3. Add a very brief module doc block to the 2d/mesh2d example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    c55dbf9 View commit details
    Browse the repository at this point in the history

  4. Move the doc block for 2d/mesh2d_manual from the main function, to … 

    …the module level.
    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    c228971 View commit details
    Browse the repository at this point in the history

  5. Add a module doc block to the 2d/move_sprite example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    f2225ec View commit details
    Browse the repository at this point in the history

  6. Add a module doc block to the 2d/rect example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    1fcbfb9 View commit details
    Browse the repository at this point in the history

  7. Add a simple module doc block to the 2d/sprite example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    eef3fdb View commit details
    Browse the repository at this point in the history

  8. Add a simple module doc block to the 2d/sprite_flipping example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    b8c6817 View commit details
    Browse the repository at this point in the history

  9. moved the comment from main to the file head

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    1c5c560 View commit details
    Browse the repository at this point in the history

  10. Add a module doc block to the 2d/text2d example.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    c2e78cf View commit details
    Browse the repository at this point in the history

  11. Cut the long comments, reworded others. 

    The plan here is having a short, but helpful, introduction to each example. Stating what is meant to be shown, without going into details.
    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    9c0c7b1 View commit details
    Browse the repository at this point in the history

  12. Add missing module doc blocks to examples. 

    I used the text from the README as a default, or comments from the `main` if they existed in the example, sometime adding a bit more context.
Some slight re-wording or layout changes where also applied.
    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    301d75b View commit details
    Browse the repository at this point in the history

  13. Some small changes to the examples README.md 

    re-sorted two groups alphabetically.
    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    445327c View commit details
    Browse the repository at this point in the history

  14. Last missing blocks after rebase.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    1b3e16b View commit details
    Browse the repository at this point in the history

  15. ran cargo fmt --all to fix whatever the IDE auto format broke.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    7b18e71 View commit details
    Browse the repository at this point in the history

  16. re-enable the markdownlint-ignore

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    c1b1da0 View commit details
    Browse the repository at this point in the history

  17. fixed some clippy md complaints in the new doc blocks

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    583acd4 View commit details
    Browse the repository at this point in the history

  18. remove unnecessary argument separator in cargo run calls

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    f9fd8b9 View commit details
    Browse the repository at this point in the history

  19. some rewording, the old one was missing words and therefore meaning.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    8313bac View commit details
    Browse the repository at this point in the history

  20. add some detail.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    64d11cb View commit details
    Browse the repository at this point in the history

  21. Add/fix some punctuation.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    dad654a View commit details
    Browse the repository at this point in the history

  22. applied @Nilirad's suggestions for example docs

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    b260137 View commit details
    Browse the repository at this point in the history

  23. added basic docs for the new example that had none.

    @themasch
    themasch committed May 15, 2022
    Configuration menu
    Copy the full SHA
    cbc2470 View commit details
    Browse the repository at this point in the history