docs: document Algorithm and Opt - #279
Merged
odow merged 2 commits intoAug 26, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://chatgpt.com/codex/tasks/019f4028-d2ae-7a12-aff0-7d996bd9c791
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #279 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 2 2
Lines 805 805
=======================================
Hits 803 803
Misses 2 2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Refactor Algorithm and Opt constructors to improve type handling and documentation.
odow
marked this pull request as ready for review
August 26, 2026 20:53
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds source-owned API docstrings for the exported
AlgorithmandOptbindings. TheAlgorithmattachment follows the conditional enum declaration because the enum is selected by the linked NLopt version;Optdocuments its construction, ownership/lifetime behavior, fields, errors, and usage.Adds a focused regression test that verifies both public bindings are present in NLopt documentation metadata.
Please ignore until reviewed by @ChrisRackauckas.
Verification
julia --startup-file=no --project=. -e 'using NLopt; docs = Base.Docs.meta(NLopt); @assert haskey(docs, Base.Docs.Binding(NLopt, :Algorithm)); @assert haskey(docs, Base.Docs.Binding(NLopt, :Opt)); println("registered public docstrings")'\n -registered public docstrings\n-julia --startup-file=no --project=. -e 'using Pkg; Pkg.test()'\n -test_runtests | 2278 2278 17m17.1s\n -Testing NLopt tests passed\n-julia --startup-file=no --project=. -e 'using JuliaFormatter; format("src"); format("test")'\n-git diff --check\n-git diff -- src/NLopt.jl test/C_API.jl | typos -\n\nNo documentation build was run because this repository has nodocs/project.\n\n🤖 Generated with Claude Code\nhttps://chatgpt.com/codex/tasks/019f4028-d2ae-7a12-aff0-7d996bd9c791