Skip to content

Conversation

@bernhardkaindl
Copy link

Docs add xcp.net classdoc to docs.3

This comment was marked as outdated.

@codecov
Copy link

codecov bot commented Sep 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classdoc-to-docs.3 branch from c52667d to 53eca83 Compare September 3, 2025 03:47
@coveralls
Copy link

coveralls commented Sep 3, 2025

Pull Request Test Coverage Report for Build 17422497550

Details

  • 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 83.358%

Totals Coverage Status
Change from base Build 17419981700: 0.0%
Covered Lines: 2790
Relevant Lines: 3347

💛 - Coveralls

This comment was marked as outdated.

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classdoc-to-docs.3 branch from 53eca83 to b0efa38 Compare September 3, 2025 03:50
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 PR adds comprehensive documentation for the xcp.net package by introducing Sphinx documentation generation and improving existing code documentation. The changes include setting up a documentation build system and standardizing docstring formatting to follow modern Python documentation conventions.

Key changes:

  • Converts legacy @param/@returns docstrings to NumPy-style documentation format
  • Adds Sphinx-based documentation infrastructure with automatic API documentation generation
  • Standardizes terminology and formatting across network interface naming documentation

Reviewed Changes

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

Show a summary per file
File Description
xcp/net/ifrename/static.py Updates docstring formatting and standardizes terminology (MAC, PCI, SMBIOS)
xcp/net/ifrename/logic.py Converts function docstrings from @param style to NumPy format and adds terminology definitions
tox.ini Adds docs environment for Sphinx documentation building
docs/source/*.rst Creates RST files for automatic API documentation generation
docs/source/conf.py Disables unused static path configuration
docs/Makefile Removes '@' prefix to show Sphinx build commands
.pre-commit-config.yaml Updates tox environment to include docs validation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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