Skip to content

Conversation

@MaxenceGollier
Copy link
Collaborator

@MaxenceGollier MaxenceGollier commented Sep 29, 2025

https://jso.dev/RegularizedOptimization.jl/previews/PR238/
A few comments :

  1. I am not sure whether the discussion on regularizers belongs here
  2. I could make a longer presentation on each algorithm but I think citing the reference is sufficient
  3. I could talk more on problems that have bounds, we could add an example in a future PR
  4. I don't mention the augmented lagrangian enough, I should add an example in the future

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 documentation to the RegularizedOptimization.jl package, including new documentation files, bibliography support, and algorithm descriptions.

  • Adds detailed package documentation with mathematical formulations and regularizer explanations
  • Introduces bibliography support with citation references for academic publications
  • Creates algorithm documentation explaining different optimization methods available

Reviewed Changes

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

Show a summary per file
File Description
docs/src/index.md Adds comprehensive package documentation including overview, regularizers table, installation instructions, and API explanations
docs/src/algorithms.md New file documenting available optimization algorithms with mathematical formulations and reference table
docs/src/bibliography.md New bibliography page for citation management
docs/references.bib Bibliography file containing academic references for the algorithms
docs/make.jl Updates documentation build configuration to include citations support and new page structure
docs/Project.toml Adds DocumenterCitations dependency and updates version constraints
docs/src/tutorial.md Removes placeholder tutorial content
docs/src/reference.md Removes contents section from reference page

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

doctest = true,
# linkcheck = true,
strict = true,
warnonly = false,
Copy link

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

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

[nitpick] The strict = true option was replaced with warnonly = false. However, warnonly is a newer Documenter.jl option. Consider using strict = [:missing_docs] or similar for more granular control over documentation strictness.

Suggested change
warnonly = false,
strict = [:missing_docs],

Copilot uses AI. Check for mistakes.

[compat]
Documenter = "~0.25"
Documenter = "1"
Copy link

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

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

[nitpick] The version constraint for Documenter changed from ~0.25 to 1, which is a major version jump. Consider using 1.0 to be more explicit about the minimum required version, and ensure compatibility with the current codebase.

Suggested change
Documenter = "1"
Documenter = "1.0"

Copilot uses AI. Check for mistakes.
@MaxenceGollier MaxenceGollier requested a review from dpo September 30, 2025 06:18
@MaxenceGollier
Copy link
Collaborator Author

@dpo you can review again.

Copy link
Member

@dpo dpo left a comment

Choose a reason for hiding this comment

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

Super, merci beaucoup.

@MaxenceGollier MaxenceGollier merged commit ae86bac into master Oct 1, 2025
12 of 13 checks passed
@MaxenceGollier MaxenceGollier deleted the documentation branch October 1, 2025 19:02
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.

4 participants