Skip to content

Conversation

@Sunnickel
Copy link
Contributor

@Sunnickel Sunnickel commented Oct 21, 2025

I'm Updating / Adding in-code documentation for rust in the whole Project (except for tests).

Description

Where ever possible, I'll add documentation in rustdoc style.

Motivation and Context

Boredom

How has this been tested?

How do I test documentation? Please just say if its written good, understandable and how it can be improved or replaced.
(fmt, audit and clippy will be run when everything is done, since this is still a draft.)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (restructuring code, without changing its behavior)

Checklist:

Since nothing is changed in code, I changed the checklist to missing packages.

  • bin
  • adapters
  • commands
  • config
  • core
  • default_commands
  • derive_macros
  • inventories
  • net
  • plugins
  • registry
  • scheduler
  • storage
  • text
  • utils
  • world

@Sunnickel Sunnickel changed the title added documentation to the bin Doc: Adding Documentation to the Project Oct 21, 2025
@Mcrtin
Copy link

Mcrtin commented Oct 21, 2025

You can add a hyphen in front of [] so GitHub recognizes the list. Also, skip world_gen. None of that code will be present once terrrain-gen branch is merged (which may take a while, but still)

@Sunnickel
Copy link
Contributor Author

You can add a hyphen in front of [] so GitHub recognizes the list. Also, skip world_gen. None of that code will be present once terrrain-gen branch is merged (which may take a while, but still)

Oh yeah, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants