Skip to content

More documenting#142

Merged
complynx merged 3 commits intomainfrom
More_documenting
Jan 28, 2026
Merged

More documenting#142
complynx merged 3 commits intomainfrom
More_documenting

Conversation

@complynx
Copy link
Collaborator

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds comprehensive documentation across the Nebius SDK codebase, including module-level docstrings, class docstrings, and function/method documentation. The PR also includes several critical bug fixes and functional improvements.

Changes:

  • Added extensive Sphinx-style documentation to base modules, protos modules, and async (aio) modules
  • Fixed critical bugs in error handling (missing raise keyword in options.py, incorrect raise usage in service_descriptor.py)
  • Improved RST rendering in generated documentation (replaced raw-html-m2r with literal role, added strikethrough support)
  • Enhanced version file handling to preserve entire file content instead of overwriting

Reviewed changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/scripts/version_updater.py Improved to preserve entire version file content when updating
src/nebius/base/options.py Added documentation + fixed missing raise keyword bug
src/nebius/aio/service_descriptor.py Added documentation + fixed incorrect raise usage (should be return) + typo fix
src/nebius/base/*.py Added comprehensive module and function documentation
src/nebius/base/protos/**/*.py Added comprehensive documentation for protobuf helpers and compiler
src/nebius/aio/token/**/*.py Added comprehensive documentation for token handling
src/nebius/base/protos/compiler/generators.py Improved RST rendering with custom m2r2 renderer
src/nebius/api/**/init.py Updated generated code with improved RST formatting
docs/templates/extra.css Added CSS support for strikethrough text in documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@complynx complynx merged commit d9fabda into main Jan 28, 2026
13 checks passed
@complynx complynx deleted the More_documenting branch January 28, 2026 15:43
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