Skip to content

docs: document Algorithm and Opt - #279

Merged
odow merged 2 commits into
jump-dev:masterfrom
ChrisRackauckas-Claude:docs/public-algorithm-opt
Aug 26, 2026
Merged

docs: document Algorithm and Opt#279
odow merged 2 commits into
jump-dev:masterfrom
ChrisRackauckas-Claude:docs/public-algorithm-opt

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

Adds source-owned API docstrings for the exported Algorithm and Opt bindings. The Algorithm attachment follows the conditional enum declaration because the enum is selected by the linked NLopt version; Opt documents 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 no docs/ project.\n\n🤖 Generated with Claude Code\nhttps://chatgpt.com/codex/tasks/019f4028-d2ae-7a12-aff0-7d996bd9c791

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

codecov Bot commented Aug 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.75%. Comparing base (f84a501) to head (7b81927).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Refactor Algorithm and Opt constructors to improve type handling and documentation.
@odow
odow marked this pull request as ready for review August 26, 2026 20:53
@odow
odow merged commit a63bf3d into jump-dev:master Aug 26, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants