Skip to content

Conversation

@bernhardkaindl
Copy link

2-new:

Docs add xcp.net classes to sphinx docs

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.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@coveralls
Copy link

coveralls commented Sep 3, 2025

Pull Request Test Coverage Report for Build 17964295374

Details

  • 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+83.4%) to 83.358%

Totals Coverage Status
Change from base Build 17930510268: 83.4%
Covered Lines: 2790
Relevant Lines: 3347

💛 - Coveralls

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from caac83a to b44b7bd Compare September 3, 2025 04:23

This comment was marked as outdated.

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from b44b7bd to 4771ee2 Compare September 3, 2025 04:30

This comment was marked as outdated.

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 enhances documentation by adding sphinx documentation generation support and improving code documentation standards. The changes focus on making the project documentation more robust and comprehensive.

  • Added sphinx documentation build configuration and integration with tox
  • Updated docstrings to follow proper sphinx/numpy-style documentation format
  • Corrected capitalization and formatting inconsistencies in comments and documentation

Reviewed Changes

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

Show a summary per file
File Description
xcp/net/ifrename/static.py Fixed capitalization inconsistencies in comments (MAC, PCI, SMBIOS)
xcp/net/ifrename/logic.py Enhanced function docstrings with proper numpy-style documentation format
tox.ini Added docs environment for sphinx documentation building
docs/source/conf.py Commented out unused static path configuration
docs/Makefile Removed @ prefix to show sphinx build output
.pre-commit-config.yaml Updated tox environment to include docs testing

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

Parameters
----------
static_rules : list[MACPCI]
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

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

The type annotation list[MACPCI] uses a generic list type that may not be available in older Python versions. Consider using List[MACPCI] from typing module or typing.List[MACPCI] for better compatibility, especially since this appears to be documentation that should be accurate across Python versions.

Copilot uses AI. Check for mistakes.
Comment on lines +390 to +409
static_rules : list[MACPCI]
List of MACPCI objects representing rules
@param cur_state
cur_state : list[MACPCI]
List of MACPCI objects representing the current state
@param last_state
last_state : list[MACPCI]
List of MACPCI objects representing the last boot state
@param old_state
old_state : list[MACPCI]
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

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

The type annotation list[MACPCI] uses a generic list type that may not be available in older Python versions. Consider using List[MACPCI] from typing module or typing.List[MACPCI] for better compatibility, especially since this appears to be documentation that should be accurate across Python versions.

Copilot uses AI. Check for mistakes.
@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch 3 times, most recently from d0c5631 to eb2cc53 Compare September 26, 2025 07:45
@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from eb2cc53 to 63c1cf0 Compare September 26, 2025 15:29
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