Skip to content

Ondra update docs#494

Merged
ondrej-lukas merged 45 commits intomainfrom
ondra-update-docs
Mar 17, 2026
Merged

Ondra update docs#494
ondrej-lukas merged 45 commits intomainfrom
ondra-update-docs

Conversation

@ondrej-lukas
Copy link
Member

@ondrej-lukas ondrej-lukas commented Mar 17, 2026

Description

  • Fixes of the documentation discrepancies and typos
  • Improved method signatures, docstrings, and typing
  • Unification of arg names in the documentation
  • imporved structure of docs

Type of change

Please delete options that are not relevant.

  • 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)
  • This change requires a documentation update

How Has This Been Tested?

Local testing with pytest and locally built docs

  • Manual testing (local run with NetSecGame)
  • Manual testing (local run with WhiteBoxNetSecGame)
  • Local docker run with NetSecGame
  • Local docker run with WhiteBoxNetSecGame

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have run local pytest
  • I have run local ruff check

@ondrej-lukas ondrej-lukas added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 17, 2026
@ondrej-lukas ondrej-lukas merged commit f169858 into main Mar 17, 2026
2 checks passed
@ondrej-lukas ondrej-lukas deleted the ondra-update-docs branch March 17, 2026 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

1 participant