docs(core/sort): document all public procedures and Interface type - #7484
Open
dominikake wants to merge 1 commit into
Open
docs(core/sort): document all public procedures and Interface type#7484dominikake wants to merge 1 commit into
dominikake wants to merge 1 commit into
Conversation
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.
Summary
Implements part of #2358 by documenting the
core:sortpackage.Adds
core/strings-style doc comments for theInterfacetype and all 29 public procedures incore/sort/sort.odin, includingInputs:/Returns:sections and runnableExample:/Output:blocks with exact expected output for every procedure.The only change is documentation comments — no behavior or logic changes.
Verification
tests/documentation/documentation_tester.odin(the CI doc test) was run against anall.odin-docbuilt from a package importing the core packages: Passes: 155, Fails: 0 · Examples verified. All 29 newsort.*examples were generated, compiled, run, and matched theirOutput:blocks exactly.odin doc core/sortrenders every public procedure/type with its doc comment.-vet/-strict-styleissues (comments only;core:sortis a library with no entry point).AI assistance disclosure
This PR was drafted with the assistance of an AI coding agent (opencode). The documentation was written from a careful reading of the actual
core/sortimplementation, and everyExample:/Output:block was verified by compiling and running against a builtodincompiler, plus the official documentation tester. No code changes were made by the AI.Refs #2358