Skip to content

Conversation

@Tuna2222
Copy link
Contributor

@Tuna2222 Tuna2222 commented Nov 5, 2025

Description

Docs:

  • Add a tutorial for the least squares problem:
    • Modify tutorials/introduction.md
    • Add a least squares example to the tutorials/least_squares folder.

Motivation and Context

Refer to the JuMP.jl Tutorials section.

How has this been tested

First, download the RLinearAlgebra.jl to your local Julia environment.
Then, open Julia in the folder of RLinearAlgebra.jl, and use the following codes to see the document:

] activate docs/
using LiveServer
servedocs()

Types of changes

  • CI
  • Docs
  • Feature
  • Fix
  • Performance
  • Refactor
  • Style
  • Test
  • Other (use sparingly):

Checklists:

Code and Comments
If this PR includes modification to the code base, please select all that apply.

  • My code follows the code style of this project.
  • I have updated all package dependencies (if any).
  • I have included all relevant files to realize the functionality of the PR.
  • I have exported relevant functionality (if any).

API Documentation

  • For every exported function (if any), I have included a detailed docstring.
  • I have checked the spelling and grammar of all docstring updates through an external tool.
  • I have checked that the docstring's function signature is correctly formatted and has all arguments.
  • I have checked that the docstring's list of arguments, fields, or return values match the function.
  • I have compiled the docs locally and read through all docstring updates to check for errors.

Manual Documentation

  • I have checked the spelling and grammar of all manual updates through an external tool.
  • Any code included in the docstring is tested using doc tests to ensure consistency.
  • I have compiled the docs locally and read through all manual updates to check for errors.

Testing

  • I have added unit tests to cover my changes. (For Macros, be sure to check
    @code_lowered and
    @code_typed)
  • All new and existing tests passed.
  • I have achieved sufficient code coverage.

@Tuna2222 Tuna2222 self-assigned this Nov 5, 2025
@Tuna2222 Tuna2222 added the documentation Improvements or additions to documentation label Nov 5, 2025
Copy link
Contributor

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 tutorial documentation, fixes a typo in documentation, and corrects a boundary condition bug in the logger's convergence check.

  • Adds tutorial documentation covering consistent linear systems and least-squares problems
  • Fixes typo in SparseSign compressor documentation ("fo" → "of")
  • Corrects iteration boundary check in BasicLogger from <= to < to prevent out-of-bounds errors

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/Solvers/Loggers/basic_logger.jl Fixed off-by-one error in iteration comparison to prevent bounds errors
src/Compressors/sparse_sign.jl Corrected typo in documentation comment
docs/src/tutorials/introduction.md Added introduction page for tutorials with problem set overview
docs/src/tutorials/consistent_system/consistent_system.md Added tutorial for solving consistent linear systems
docs/src/tutorials/consistent_system/consistent_system_configure.md Added advanced tutorial showing modular customization of solvers
docs/src/tutorials/least_squares/least_squares.md Added tutorial for solving least-squares problems
docs/src/tutorials/least_squares/least_squares_configure.md Added placeholder for least-squares customization tutorial
docs/make.jl Enabled tutorials section in documentation
.github/workflows/Documenter.yml Simplified workflow triggers, removed obsolete branches

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

# Modular Customization: More Compressors


This doc will introduce more compressors, and left the other modules,
Copy link

Copilot AI Nov 5, 2025

Choose a reason for hiding this comment

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

Grammatical error: 'left' should be 'leave' to maintain proper verb tense consistency.

Suggested change
This doc will introduce more compressors, and left the other modules,
This doc will introduce more compressors, and leave the other modules,

Copilot uses AI. Check for mistakes.
@codecov
Copy link

codecov bot commented Nov 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants