Conversation
pyproject.toml
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #87 +/- ##
=======================================
Coverage 94.23% 94.23%
=======================================
Files 6 6
Lines 104 104
Branches 39 39
=======================================
Hits 98 98
Misses 3 3
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation infrastructure for the Sudoku_Validation package by adding runnable tutorials and examples, enabling navigation features, fixing environment and gitignore configurations, and improving test documentation.
Changes:
- Added runnable tutorial (tutorials/usage.qmd) and standalone example script (examples/usage.py) demonstrating all package functions
- Enhanced Quarto configuration with table of contents, sidebar navigation, and tutorial link
- Updated project URLs in pyproject.toml to point to correct GitHub organization and documentation site
- Added jupyter and nbformat dependencies to environment.yml for Quarto notebook support
- Added _freeze/ pattern to .gitignore for Quarto cache files
- Added clarifying comments to test cases explaining test setup and expected behavior
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tutorials/usage.qmd | New Quarto tutorial with executable Python examples demonstrating all validation functions |
| examples/usage.py | New standalone Python script with runnable usage examples for all package functions |
| tests/unit/test_combined_validation.py | Added descriptive comments explaining test setup, board state, and indices being tested |
| pyproject.toml | Updated project URLs from invalid format to correct UBC-MDS organization and GitHub Pages documentation |
| index.qmd | Enabled table of contents for better navigation |
| _quarto.yml | Added tutorial link to navbar and comprehensive sidebar with anchor links to README sections |
| README.md | Added "Usage (runnable examples)" section with complete code examples and converted URLs to proper Markdown links |
| environment.yml | Added jupyter and nbformat dependencies required for Quarto Python notebooks |
| .gitignore | Added _freeze/ directory pattern for Quarto cache exclusion |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **square_validation(board)**: Validates that each 3x3 square in a 9x9 Sudoku board contains all digits from 1 to 9 exactly once. | ||
|
|
||
| ## Position in the Python Ecosystem | ||
| ## Position in the Python Ecosystem |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
| > Note: this package is a work in progress and might contain example code that is not used in the final product. | ||
|
|
||
| ## Get started | ||
| ## Get started |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
| print('combined_validation (incomplete but valid):', combined_validation(incomplete)) | ||
| ``` | ||
|
|
||
| ## Documentation |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
|
|
||
|
|
||
| ## For Developers | ||
| ## For Developers |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
|
|
||
|
|
||
| ## Contributing | ||
| ## Contributing |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
| Submitting pull requests | ||
|
|
||
| ## Contributors | ||
| ## Contributors |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
| Omowunmi Obadero: obaderoomowunmi@gmail.com | ||
|
|
||
| ## Copyright | ||
| ## Copyright |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
|
|
||
| ## Package Contents | ||
|
|
||
| ## Package Contents |
There was a problem hiding this comment.
Trailing space after the header. While this doesn't break functionality in Markdown, it's inconsistent with the rest of the codebase where headers don't have trailing spaces (see CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEVELOPMENT.md). Consider removing trailing spaces from all headers for consistency.
2 participants
Added runnable tutorial and examples, enable TOC/sidebar, fix docs/env/gitignore, and clarify tests.